Talk:Repository.Pool.GetAllPools/Notes: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '<onlyinclude>Gets a list of spare part pools associated with a project. Returns a '''cPool''' object array that contains the pools in that project.</onlyinclude> …')
 
(Applied V10.1 updates to main topic)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<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 ==
'''.Pool.GetAllPools'''(''Filter'')
===Parameters===
''Filter''
:Optional. A filter that returns a particular type of pool resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local pools only.
== Example ==
This example assumes that spare part pools exist in the first available project of a repository.
'''VBA|VB.NET'''
{{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
 
{{APIComment|'Get a list of all local spare part pools in project #1.}}
  {{APIPrefix|Dim}} ListofPools() {{APIPrefix|As}} cPool
  MyRepository.Project.SetCurrentProject (1) 
  ListofPools = MyRepository.Pool.GetAllPools()
{{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1
  MsgBox (NumberofElements)

Latest revision as of 15:44, 1 March 2016