Repository.Crew.AddCrew: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{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.  
 
<onlyinclude>Adds a new crew resource to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>
 
 
'''Remarks''': 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 ==
''object''.'''Crew.AddCrew(''crew'')'''
'''.Crew.AddCrew'''(''crew'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== Parameters ===
{| {{APITable}}
''crew''
|-
:Required. The [[CCrew Class|cCrew]] object that represents the crew resource to be added.
|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|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew."}}
  {{APIPrefix|Dim}} NewCrew {{APIPrefix|As New}} cCrew
  NewCrew.Name = {{APIString|"MyNewCrew"}}
   
   
{{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew".}}
  {{APIComment|'Add the new crew to project #1.}}
  {{APIPrefix|Dim}} NewCrew {{APIPrefix|As New}} cCrew
  MyRepository.Project.SetCurrentProject(1)   
  NewCrew.Name = {{APIString|"MyNewCrew"}}
  {{APIPrefix|Call}} MyRepository.Crew.AddCrew(NewCrew)
  {{APIComment|'Add the new crew to project #1. The crew will be visible in the Synthesis repository upon refresh.}}
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Call}} MyRepository.Crew.AddCrew(NewCrew)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  {{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew".}}
 
  {{APIPrefix|Dim}} NewCrew {{APIPrefix|As New}} cCrew ({{APIString|"MyNewCrew"}})
  {{APIComment|'Create a new crew. The following example creates a crew named "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)

Latest revision as of 20:34, 18 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Adds a new crew resource to the current project. Returns a Boolean value; when true, indicates a successful save.


Remarks: 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 that represents the crew resource to be added.


Example

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

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 '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

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 '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)