Repository.Crew.GetCrew: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
 


Gets the crew with the designated ID number and returns it as a '''[[CCrew Class|cCrew]]''' object. Returns nothing if the crew does not exist or is not in the current project.  
Gets the crew with the designated ID number and returns it as a '''[[CCrew Class|cCrew]]''' object. Returns nothing if the crew does not exist or is not in the current project.  
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Crew.GetCrew(''ID'')'''
'''.Crew.GetCrew(''ID'')'''
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''ID''
|-
:Integer. The ID number of the crew to retrieve.
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the crew to retrieve.
|}




Line 19: Line 15:
  '''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|'Get crew #1 from project #1.}}
  {{APIComment|'Get crew #1 from project #1.}}
   {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
   {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
Line 36: Line 34:
  '''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|'Get crew #1 from project #1.}}
  {{APIComment|'Get crew #1 from project #1.}}

Revision as of 20:45, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets the crew with the designated ID number and returns it as a cCrew object. Returns nothing if the crew does not exist or is not in the current project.

Syntax

.Crew.GetCrew(ID)

Parameters

ID

Integer. The ID number of the crew to retrieve.


Example

This example assumes that a crew with ID#1 exists in a repository.

VBA

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

 
 '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

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


 '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)