Repository.Crew.AddCrew: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Saves a new [[CCrew Class|cCrew]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>  
<onlyinclude>Adds a new crew to a Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>  


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.
If a crew with the same name already exists in the destination project, the name will be incremented automatically. For example, if "Crew1" already exists, the new crew might be renamed to "Crew2," "Crew3," etc.


== Syntax ==
== Syntax ==
  '''.Crew.AddCrew'''(''crew'')
  '''.Crew.AddCrew'''(''crew'')
=== Parameters ===
=== Parameters ===
''crew''
''crew''
:The [[CCrew Class|cCrew]] object to be added. (Required)
:Required. The [[CCrew Class|cCrew]] object to be added. (Required)




Line 26: Line 27:
   NewCrew.Name = {{APIString|"MyNewCrew"}}
   NewCrew.Name = {{APIString|"MyNewCrew"}}
   
   
  {{APIComment|'Add the new crew to project #1. The crew will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new crew to project #1.}}
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   {{APIPrefix|Call}} MyRepository.Crew.AddCrew(NewCrew)
   {{APIPrefix|Call}} MyRepository.Crew.AddCrew(NewCrew)
Line 40: Line 41:
   {{APIPrefix|Dim}} NewCrew {{APIPrefix|As New}} cCrew ({{APIString|"MyNewCrew"}})
   {{APIPrefix|Dim}} NewCrew {{APIPrefix|As New}} cCrew ({{APIString|"MyNewCrew"}})
   
   
  {{APIComment|'Add the new crew to project #1. The crew will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new crew to project #1.}}
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Crew.AddCrew(NewCrew)
   MyRepository.Crew.AddCrew(NewCrew)

Revision as of 21:46, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Adds a new crew to a Synthesis repository. Returns a Boolean value; when true, indicates a successful save.

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

Syntax

.Crew.AddCrew(crew)

Parameters

crew

Required. 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. 
 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. 
 MyRepository.Project.SetCurrentProject(1)   
 MyRepository.Crew.AddCrew(NewCrew)