Repository.Crew.GetAllCrews: 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.GetAllCrews.Cmt}}


==Syntax==
Gets a list of all existing crews in the current project. Returns a '''[[CCrew Class|cCrew]]''' object array that contains the crew names, ID numbers and other information. 
*GetAllCrews(){{APIPrefix|As}}[[cCrew Class|cCrew]]()
<noinclude>
== Syntax ==
''object''.'''Crew.GetAllCrews()'''


== Usage Example ==
where ''object'' is a variable that represents a Repository object.
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
== Example ==
  Dim MyRepository As New Repository
This example assumes that crews exist in the first available project of a repository.
 
 
  {{APIComment|'Connect to the Synthesis repository.}}
'''VBA|VB.NET'''
  Dim Success As Boolean = False
   
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Set a first available project as current.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIComment|'Get a list of all crews in project #1.}}
  {{APIPrefix|Dim}} ListofCrews() {{APIPrefix|As}} cCrew
   MyRepository.Project.SetCurrentProject (1) 
  ListofCrews = MyRepository.Crew.GetAllCrews()
   
   
  {{APIComment|'Get the list of Crews in the current project.}}
  {{APIComment|'Output sample: Display the name and ID of the first available crew in the project.}}
   Dim ListOfCrews() As [[cCrew Class|cCrew]]
   {{APIPrefix|Dim}} CrewName {{APIPrefix|As}} String
   ListOfCrews = MyRepository.Crew.GetAllCrews()
  {{APIPrefix|Dim}} CrewID {{APIPrefix|As}} Integer
</div>
   CrewName = ListofCrews(0).Name
  CrewID = ListofCrews(0).ID
  MsgBox ({{APIString|"The first scheduled crew is: "}} & CrewName & {{APIString|", ID#"}} & CrewID)
</noinclude>

Revision as of 20:35, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

Gets a list of all existing crews in the current project. Returns a cCrew object array that contains the crew names, ID numbers and other information.

Syntax

object.Crew.GetAllCrews()

where object is a variable that represents a Repository object.

Example

This example assumes that crews exist in the first available project of a repository. 

VBA|VB.NET

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

 'Get a list of all crews in project #1. 
 Dim ListofCrews() As cCrew
 MyRepository.Project.SetCurrentProject (1)  
 ListofCrews = MyRepository.Crew.GetAllCrews()

 'Output sample: Display the name and ID of the first available crew in the project. 
 Dim CrewName As String
 Dim CrewID As Integer
 CrewName = ListofCrews(0).Name
 CrewID = ListofCrews(0).ID
 MsgBox ("The first scheduled crew is: " & CrewName & ", ID#" & CrewID)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Crew.GetAllCrews&oldid=59432"