Repository.Crew.GetAllCrews: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:




<onlyinclude>Gets a list of crews associated with a project (does not include global or reference crews). Returns a '''[[CCrew Class|cCrew]]''' object array that contains all the crews in that project.</onlyinclude>   
<onlyinclude>Returns an array of '''[[CCrew Class|cCrew]]''' objects that represent the crew resources in the current project.</onlyinclude>   


== Syntax ==
== Syntax ==
  '''.Crew.GetAllCrews()'''
  '''.Crew.GetAllCrews'''(''Filter'')
 
===Parameters===
''Filter''
:Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.




Line 13: Line 17:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{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
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Get a list of all local crews in project #1.}}
  {{APIComment|'Get a list of all crews in project #1.}}
  {{APIPrefix|Dim}} ListofCrews() {{APIPrefix|As}} cCrew
  {{APIPrefix|Dim}} ListofCrews() {{APIPrefix|As}} cCrew
  MyRepository.Project.SetCurrentProject (1)   
  MyRepository.Project.SetCurrentProject (1)   
  ListofCrews = MyRepository.Crew.GetAllCrews()
  ListofCrews = MyRepository.Crew.GetAllCrews()
   
   
  {{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIComment|'Output sample: Display the number of crews in the project.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofCrews) - LBound(ListofCrews) + 1
  NumberofElements = UBound(ListofCrews) - LBound(ListofCrews) + 1
  MsgBox (NumberofElements)
  MsgBox (NumberofElements)

Latest revision as of 18:52, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of cCrew objects that represent the crew resources in the current project.

Syntax

.Crew.GetAllCrews(Filter)

Parameters

Filter

Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local resources only.


Example

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

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get a list of all local crews in project #1. 
  Dim ListofCrews() As cCrew
  MyRepository.Project.SetCurrentProject (1)  
  ListofCrews = MyRepository.Crew.GetAllCrews()

 'Output sample: Display the number of crews in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofCrews) - LBound(ListofCrews) + 1
  MsgBox (NumberofElements)