Repository.Pool.GetAllPools: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>


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

Revision as of 17:24, 17 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

Gets a list of all existing spare part pools in the current project. Returns a cPool object array that contains the spare part pool names, ID numbers and other information.

Syntax

object.Pool.GetAllPools()

where object is a variable that represents a Repository object.

Example

This example assumes that spare part pools exist in the first available project of a repository.

VBA|VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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 name and ID of the first available spare part pool in the project. 
 Dim PoolName As String
 Dim PoolID As Integer
 PoolName = ListofPools(0).Name
 PoolID = ListofPools(0).ID
 MsgBox ("The first spare part pool is: " & PoolName & ", ID#" & PoolID)