Repository.Pool.GetAllPools

From ReliaWiki
Revision as of 00:15, 1 March 2016 by Kate Racaza (talk | contribs) (V10.1: Updated to document new parameter)
Jump to navigation Jump to search
APIWiki.png


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)