Repository.Crew.GetCrew: Difference between revisions

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


==Syntax==
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.
* GetCrew({{APIPrefix|As}} [[cCrew Class|cCrew]])
<noinclude>
== Syntax ==
''object''.'''Crew.GetCrew(''ID'')'''


Parameters
where ''object'' is a variable that represents a Repository object.


Enter the Crew ID to get desired crew.
=== Parameters ===
{| {{APITable}}
|-
|ID{{APIParam|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 a repository.
    
'''VBA'''
  {{APIComment|'Connect to the Synthesis repository.}}
   Dim Success As Boolean = False
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  {{APIComment|...'Add code to connect to a Synthesis repository.}} 
    
  {{APIComment|'Set a first available project as current.}}
{{APIComment|'Get crew #1 from project #1.}}
   MyRepository.Project.SetCurrentProject(0)
   {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
 
  MyRepository.Project.SetCurrentProject(1)
  {{APIComment|'Get a Crew with the ID of 1.}}
   {{APIPrefix|Set}} MyCrew = MyRepository.Crew.GetCrew(1)
   Dim GetCrew() as cCrew
   GetCrew= MyRepository.Crew.GetCrew(1)
  {{APIComment|'Output sample:}}
  {{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'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}} 
{{APIComment|'Get crew #1 from project #1.}}
  {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
   MyRepository.Project.SetCurrentProject(1)
  MyCrew = MyRepository.Crew.GetCrew(1)
  {{APIComment|'Output sample:}}
  {{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)
</noinclude>

Revision as of 22:53, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

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

object.Crew.GetCrew(ID)

where object is a variable that represents a Repository object.

Parameters

Name Description
IDborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status Integer. The ID number of the crew to retrieve.


Example

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

VBA

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

 'Get crew #1 from project #1. 
 Dim MyCrew As cCrew
 MyRepository.Project.SetCurrentProject(1)
 Set MyCrew = MyRepository.Crew.GetCrew(1)

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

VB.NET 

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

 'Get crew #1 from project #1. 
 Dim MyCrew As cCrew
 MyRepository.Project.SetCurrentProject(1)
 MyCrew = MyRepository.Crew.GetCrew(1)

 'Output sample: 
 Dim CrewName As String
 Dim CrewID As Integer
 CrewName = MyCrew.Name
 CrewID = MyCrew.ID
 MsgBox ("You got " & CrewName & ", ID#" & CrewID)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Crew.GetCrew&oldid=59470"