Repository.Crew.GetAllCrews: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 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]]}}
 
 
<onlyinclude>Returns an array of '''[[CCrew Class|cCrew]]''' objects that represent the crew resources in the current project.</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. 
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''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.


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


== Example ==
== Example ==
Line 13: Line 17:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{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 a list of all crews in project #1.}}
 
  {{APIPrefix|Dim}} ListofCrews() {{APIPrefix|As}} cCrew
  {{APIComment|'Get a list of all local crews in project #1.}}
  MyRepository.Project.SetCurrentProject (1)   
  {{APIPrefix|Dim}} ListofCrews() {{APIPrefix|As}} cCrew
  ListofCrews = MyRepository.Crew.GetAllCrews()
  MyRepository.Project.SetCurrentProject (1)   
  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 crews in the project.}}
  {{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)
</noinclude>

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