Repository.Crew.GetCrew: Difference between revisions

Latest revision as of 18:52, 9 June 2016

Returns a cCrew object that represents a given crew resource in the current project. Returns nothing if the crew does not exist or is not in the current project.

Syntax

.Crew.GetCrew(ID)

Parameters

ID

Required. Integer. The ID number of the crew to retrieve.

Example

This example assumes that a crew with ID #1 exists in the first project of 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")
  
 'Get crew #1 from project #1. 
  Dim MyCrew As cCrew
  MyRepository.Project.SetCurrentProject(1)
  Set MyCrew = MyRepository.Crew.GetCrew(1)

 'Output sample: Display the name and ID of the crew. 
  Dim CrewName As String
  Dim CrewID As Integer
  CrewName = MyCrew.Name
  CrewID = MyCrew.ID
  MsgBox ("You got " & CrewName & ", ID#" & CrewID)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Get crew #1 from project #1. 
  Dim MyCrew As cCrew
  MyRepository.Project.SetCurrentProject(1)
  MyCrew = MyRepository.Crew.GetCrew(1)

 'Output sample: Display the name and ID of the crew. 
  Dim CrewName As String
  Dim CrewID As Integer
  CrewName = MyCrew.Name
  CrewID = MyCrew.ID
  MsgBox ("You got " & CrewName & ", ID#" & CrewID)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-{{Template:Repository.GetCrew.Cmt}}
-==Syntax==
-* GetCrew({{APIPrefix|As}} [[cCrew Class|cCrew]])
-Parameters
+<onlyinclude>Returns a '''[[CCrew Class|cCrew]]''' object that represents a given crew resource in the current project. Returns nothing if the crew does not exist or is not in the current project.</onlyinclude>
-Enter the Crew ID to get desired crew.
+== Syntax ==
+ '''.Crew.GetCrew'''(''ID'')
+=== Parameters ===
+''ID''
+:Required. Integer. The ID number of the crew to retrieve.
-== Usage Example ==
-  {{APIComment|'Declare a new repository connection object.}}
+== Example ==
-  Dim MyRepository As New Repository
+This example assumes that a crew with ID #1 exists in the first project of a Synthesis repository.
+ '''VBA'''
-  {{APIComment|'Connect to the Synthesis repository.}}
-  Dim Success As Boolean = False
+  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
-  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
-  {{APIComment|'Get the list of crews in the connected repository.}}
-  Dim ListOfCrews() As [[cCrew Class|cCrew]]
+  {{APIComment|'Get crew #1 from project #1.}}
-  ListOfCrews = MyRepository.Crew.GetAllCrews()
+   {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
+   MyRepository.Project.SetCurrentProject(1)
+   {{APIPrefix|Set}} MyCrew = MyRepository.Crew.GetCrew(1)
+  {{APIComment|'Output sample: Display the name and ID of the crew.}}
+   {{APIPrefix|Dim}} CrewName {{APIPrefix|As}} String
+   {{APIPrefix|Dim}} CrewID {{APIPrefix|As}} Integer
+   CrewName = MyCrew.Name
+   CrewID = MyCrew.ID
+   MsgBox ({{APIString|"You got "}} & CrewName & {{APIString|", ID#"}} & CrewID)
+ '''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|'Get a Crew.}}
+  {{APIComment|'Get crew #1 from project #1.}}
-  Dim GetCrew() as cCrew
+   {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
-  GetCrew= MyRepository.Crew.GetCrew(1)
+   MyRepository.Project.SetCurrentProject(1)
+   MyCrew = MyRepository.Crew.GetCrew(1)
+ {{APIComment|'Output sample: Display the name and ID of the crew.}}
+   {{APIPrefix|Dim}} CrewName {{APIPrefix|As}} String
+   {{APIPrefix|Dim}} CrewID {{APIPrefix|As}} Integer
+   CrewName = MyCrew.Name
+   CrewID = MyCrew.ID
+   MsgBox ({{APIString|"You got "}} & CrewName & {{APIString|", ID#"}} & CrewID)

Repository.Crew.GetCrew: Difference between revisions

Latest revision as of 18:52, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search