Repository.Pool.GetPool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No 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 the spare part pool with the designated ID number and returns it as a '''[[CPool Class|cPool]]''' object. Returns nothing if the spare part pool does not exist or is not in the current project.  
Gets the spare part pool with the designated ID number and returns it as a '''[[CPool Class|cPool]]''' object. Returns nothing if the spare part pool does not exist or is not in the current project.  

Revision as of 17:29, 17 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

Gets the spare part pool with the designated ID number and returns it as a cPool object. Returns nothing if the spare part pool does not exist or is not in the current project.

Syntax

object.Pool.GetPool(ID)

where object is a variable that represents a Repository object.

Parameters

Name Description
IDborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status Integer. The ID number of the spare part pool to retrieve.


Example

This example assumes that a spare part pool with ID#1 exists in a repository.

VBA

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository.   

 'Get spare part pool #1 from project #1. 
 Dim MyPool As cPool
 MyRepository.Project.SetCurrentProject(1)
 Set MyPool = MyRepository.Pool.GetPool(1)

 'Output sample: Display the name and ID of the pool. 
 Dim PoolName As String
 Dim PoolID As Integer
 PoolName = MyPool.Name
 PoolID = MyPool.ID
 MsgBox ("You got " & PoolName & ", ID#" & PoolID)
VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository.   

 'Get spare part pool #1 from project #1. 
 Dim MyPool As cPool
 MyRepository.Project.SetCurrentProject(1)
 MyPool = MyRepository.Pool.GetPool(1)

 'Output sample: Display the name and ID of the pool. 
 Dim PoolName As String
 Dim PoolID As Integer
 PoolName = MyPool.Name
 PoolID = MyPool.ID
 MsgBox ("You got " & PoolName & ", ID#" & PoolID)