Repository.Pool.GetPool: Difference between revisions

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





Revision as of 22:17, 13 November 2015

APIWiki.png


Member of: SynthesisAPI.Repository


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

.Pool.GetPool(ID)

Parameters

ID

Required. 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 the first project of a Synthesis repository.

VBA

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New 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

 'Add code to connect to a Synthesis repository. 
 Dim MyRepository As New 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)