Repository.Crew.AddCrew: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}
Saves a new [[CCrew Class|cCrew]] object to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates that the crew now exists in the repository.


Saves a new [[CCrew Class|cCrew]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.
<noinclude>
If a crew with the same name already exists in the current project, the application will automatically increment the name. For example, if "Crew1" already exists, the new crew might be renamed to "Crew2," "Crew3," etc.
== Syntax ==
== Syntax ==
''object''.'''Crew.AddCrew(''crew'')'''
'''.Crew.AddCrew'''(''crew'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''crew''
|-
:The [[CCrew Class|cCrew]] object to be added. (Required)
|crew{{APIParam|Required}}||The [[CCrew Class|cCrew]] object to be added  
|}




== Example ==
== Example ==
This example creates a new crew resource, and then saves it in the first available project in a Synthesis repository.
  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
  {{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew."}}
  {{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew."}}
Line 31: Line 31:
  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
  {{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew."}}
  {{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew."}}
Line 40: Line 42:
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Crew.AddCrew(NewCrew)
   MyRepository.Crew.AddCrew(NewCrew)
</noinclude>

Revision as of 18:52, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Saves a new cCrew object to the current project. Returns a Boolean value; when true, indicates a successful save.

If a crew with the same name already exists in the current project, the application will automatically increment the name. For example, if "Crew1" already exists, the new crew might be renamed to "Crew2," "Crew3," etc.

Syntax

.Crew.AddCrew(crew)

Parameters

crew

The cCrew object to be added. (Required)


Example

This example creates a new crew resource, and then saves it in the first available project in a Synthesis repository.

VBA

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 'Create a new crew. The following example creates a crew named "MyNewCrew." 
 Dim NewCrew As New cCrew
 NewCrew.Name = "MyNewCrew"

 'Add the new crew to project #1. The crew will be visible in the Synthesis repository upon refresh. 
 MyRepository.Project.SetCurrentProject(1)   
 Call MyRepository.Crew.AddCrew(NewCrew)
VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 'Create a new crew. The following example creates a crew named "MyNewCrew." 
 Dim NewCrew As New cCrew ("MyNewCrew")

 'Add the new crew to project #1. The crew will be visible in the Synthesis repository upon refresh. 
 MyRepository.Project.SetCurrentProject(1)   
 MyRepository.Crew.AddCrew(NewCrew)