Repository.Pool.GetAllPools: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
Kate Racaza (talk | contribs) (V10.1: Updated to document new parameter) |
||
| Line 2: | Line 2: | ||
<onlyinclude>Gets a list of spare part pools associated with a project | <onlyinclude>Gets a list of spare part pools associated with a project. Returns a '''[[CPool Class|cPool]]''' object array that contains the pools in that project.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
'''.Pool.GetAllPools()''' | '''.Pool.GetAllPools'''(''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 18: | Line 22: | ||
{{APIComment|'Get a list of all spare part pools in project #1.}} | {{APIComment|'Get a list of all local spare part pools in project #1.}} | ||
{{APIPrefix|Dim}} ListofPools() {{APIPrefix|As}} cPool | {{APIPrefix|Dim}} ListofPools() {{APIPrefix|As}} cPool | ||
MyRepository.Project.SetCurrentProject (1) | MyRepository.Project.SetCurrentProject (1) | ||
Revision as of 00:15, 1 March 2016
 |
Member of: SynthesisAPI.Repository
Gets a list of spare part pools associated with a project. Returns a cPool object array that contains the pools in that project.
Syntax
.Pool.GetAllPools(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 spare part pools 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 local spare part pools in project #1. Dim ListofPools() As cPool MyRepository.Project.SetCurrentProject (1) ListofPools = MyRepository.Pool.GetAllPools() 'Output sample: Display the number of elements in the array. Dim NumberofElements As Integer NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1 MsgBox (NumberofElements)