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 spare part pools associated with a project. Returns a '''[[CPool Class|cPool]]''' object that represents the spare part pools.</onlyinclude>   
<onlyinclude>Gets an array of '''[[CPool Class|cPool]]''' objects that represent the spare part pools in the current project.</onlyinclude>   


== Syntax ==
== Syntax ==

Revision as of 22:51, 8 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


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