Repository.Pool.GetAllPools: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb | {{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | ||
<onlyinclude> | <onlyinclude>Returns an array of '''[[CPool Class|cPool]]''' objects that represent the spare part pools in the current 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 13: | 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 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) | ||
ListofPools = MyRepository.Pool.GetAllPools() | ListofPools = MyRepository.Pool.GetAllPools() | ||
{{APIComment|'Output sample: Display the | {{APIComment|'Output sample: Display the number of pools in the project.}} | ||
{{APIPrefix|Dim}} | {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer | ||
NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1 | |||
MsgBox (NumberofElements) | |||
MsgBox ( | |||
Latest revision as of 18:54, 9 June 2016
 |
Member of: SynthesisAPI.Repository
Returns an array of cPool objects that represent the spare part pools in the current 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 '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)