Repository.Pool.GetAllPools: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Gets a list of all existing spare part pools in the current project. Returns a '''[[CPool Class|cPool]]''' object array that contains the spare part pool names, ID numbers and other information.</onlyinclude>   
<onlyinclude>Gets a list of spare part pools associated with a project. Returns a '''[[CPool Class|cPool]]''' object array that contains all the pools in that project.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 23: Line 23:
   ListofPools = MyRepository.Pool.GetAllPools()
   ListofPools = MyRepository.Pool.GetAllPools()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available spare part pool in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} PoolName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} PoolID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1
   PoolName = ListofPools(0).Name
   MsgBox (NumberofElements)
  PoolID = ListofPools(0).ID
   MsgBox ({{APIString|"The first spare part pool is: "}} & PoolName & {{APIString|", ID#"}} & PoolID)

Revision as of 22:57, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of spare part pools associated with a project. Returns a cPool object array that contains all the pools in that project.

Syntax

.Pool.GetAllPools()


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 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)