Difference between revisions of "Repository.Crew.AddCrew"

From ReliaWiki
Jump to navigation Jump to search
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
+
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.AddCrew.Cmt}} {{Template:BooleanReturn.Cmt}}
 
  
==Syntax==
 
*AddCrew( crew {{APIPrefix|As}} [[cCrew Class|cCrew]] ){{APIPrefix|As Boolean}}
 
  
Parameters
+
<onlyinclude>Adds a new crew resource to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>
:''crew'': The [[cCrew Class|cCrew]] to add.
 
  
== Usage Example ==
+
 
  {{APIComment|'Declare a new repository connection object.}}
+
'''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.
  Dim MyRepository As New Repository
+
 
 +
== Syntax ==
 +
'''.Crew.AddCrew'''(''crew'')
 +
 
 +
=== Parameters ===
 +
''crew''
 +
:Required. The [[CCrew Class|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'''
 +
 +
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
 +
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 +
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
    
 
    
  {{APIComment|'Connect to the Synthesis repository.}}
+
  {{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew."}}
  Dim Success As Boolean = False
+
  {{APIPrefix|Dim}} NewCrew {{APIPrefix|As New}} cCrew
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+
  NewCrew.Name = {{APIString|"MyNewCrew"}}
 
+
  {{APIComment|'Declare a new crew.}}
+
{{APIComment|'Add the new crew to project #1.}}
  Dim newCrew As New cCrew("NewCrew1")
+
  MyRepository.Project.SetCurrentProject(1)    
 +
  {{APIPrefix|Call}} MyRepository.Crew.AddCrew(NewCrew)
 +
 
 +
'''VB.NET'''
 +
 +
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
 +
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 +
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
    
 
    
  {{APIComment|'Add the crew to the repository.}}
+
{{APIComment|'Create a new crew. The following example creates a crew named "MyNewCrew."}}
   Dim SuccessAddCrew As Boolean
+
  {{APIPrefix|Dim}} NewCrew {{APIPrefix|As New}} cCrew ({{APIString|"MyNewCrew"}})
  SuccessAddCrew = MyRepository.AddCrew(newCrew)
+
 +
  {{APIComment|'Add the new crew to project #1.}}
 +
  MyRepository.Project.SetCurrentProject(1)    
 +
  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)