Repository.Pool.GetAllPools: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) (V10.1: Updated to document new parameter) |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude>Gets a list of spare part pools associated with a project. Returns a '''[[CPool Class|cPool]]''' object | <onlyinclude>Gets a list of spare part pools associated with a project. Returns a '''[[CPool Class|cPool]]''' object that represents the spare part pools.</onlyinclude> | ||
== Syntax == | == Syntax == | ||
| Line 17: | Line 17: | ||
'''VBA|VB.NET''' | '''VBA|VB.NET''' | ||
{{APIComment|' | {{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 | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{APIComment|'Get a list of all local 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 | ||
| Line 27: | Line 26: | ||
ListofPools = MyRepository.Pool.GetAllPools() | ListofPools = MyRepository.Pool.GetAllPools() | ||
{{APIComment|'Output sample: Display the number of | {{APIComment|'Output sample: Display the number of pools in the project.}} | ||
{{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer | {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer | ||
NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1 | NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1 | ||
MsgBox (NumberofElements) | MsgBox (NumberofElements) | ||
Revision as of 17:42, 8 April 2016
 |
Member of: SynthesisAPI.Repository
Gets a list of spare part pools associated with a project. Returns a cPool object that represents the spare part pools.
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 '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 spare part pools in project #1. Dim ListofPools() As cPool MyRepository.Project.SetCurrentProject (1) ListofPools = MyRepository.Pool.GetAllPools() 'Output sample: Display the number of pools in the project. Dim NumberofElements As Integer NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1 MsgBox (NumberofElements)