Repository.Crew.GetCrew: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}


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>
== Syntax ==
''object''.'''Crew.GetCrew(''ID'')'''


where ''object'' is a variable that represents a Repository object.
<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>


== Syntax ==
'''.Crew.GetCrew'''(''ID'')
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''ID''
|-
:Required. Integer. The ID number of the crew to retrieve.
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the crew to retrieve.
|}




== Example ==
== Example ==
This example assumes that a crew with ID#1 exists in a repository.
This example assumes that a crew with ID #1 exists in the first project of 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|'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
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Set}} MyCrew = MyRepository.Crew.GetCrew(1)
  {{APIPrefix|Set}} MyCrew = MyRepository.Crew.GetCrew(1)
   
   
  {{APIComment|'Output sample:}}
  {{APIComment|'Output sample: Display the name and ID of the crew.}}
  {{APIPrefix|Dim}} CrewName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} CrewName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} CrewID {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} CrewID {{APIPrefix|As}} Integer
  CrewName = MyCrew.Name
  CrewName = MyCrew.Name
  CrewID = MyCrew.ID
  CrewID = MyCrew.ID
  MsgBox ({{APIString|"You got "}} & CrewName & {{APIString|", ID#"}} & CrewID)
  MsgBox ({{APIString|"You got "}} & CrewName & {{APIString|", ID#"}} & CrewID)


'''VB.NET'''
'''VB.NET'''
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}} 
   
   
{{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 crew #1 from project #1.}}
  {{APIComment|'Get crew #1 from project #1.}}
  {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
  {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  MyCrew = MyRepository.Crew.GetCrew(1)
  MyCrew = MyRepository.Crew.GetCrew(1)
   
   
  {{APIComment|'Output sample:}}
  {{APIComment|'Output sample: Display the name and ID of the crew.}}
  {{APIPrefix|Dim}} CrewName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} CrewName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} CrewID {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} CrewID {{APIPrefix|As}} Integer
  CrewName = MyCrew.Name
  CrewName = MyCrew.Name
  CrewID = MyCrew.ID
  CrewID = MyCrew.ID
  MsgBox ({{APIString|"You got "}} & CrewName & {{APIString|", ID#"}} & CrewID)
  MsgBox ({{APIString|"You got "}} & CrewName & {{APIString|", ID#"}} & CrewID)
</noinclude>

Latest revision as of 18:52, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Crew.GetCrew&oldid=64314"