Repository.Crew.GetAllCrews: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>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.</onlyinclude>   
<onlyinclude>Gets a list of crews associated with a project. Returns a '''[[CCrew Class|cCrew]]''' object array that contains all the crews in that project.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 23: Line 23:
   ListofCrews = MyRepository.Crew.GetAllCrews()
   ListofCrews = MyRepository.Crew.GetAllCrews()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available crew in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} CrewName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} CrewID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofCrews) - LBound(ListofCrews) + 1
   CrewName = ListofCrews(0).Name
   MsgBox (NumberofElements)
  CrewID = ListofCrews(0).ID
   MsgBox ({{APIString|"The first crew is: "}} & CrewName & {{APIString|", ID#"}} & CrewID)

Revision as of 22:55, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of crews associated with a project. Returns a cCrew object array that contains all the crews in that project.

Syntax

.Crew.GetAllCrews()


Example

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

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New 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 number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofCrews) - LBound(ListofCrews) + 1
 MsgBox (NumberofElements)