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 Class|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.  
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Pool.GetPool(''ID'')'''
'''.Pool.GetPool(''ID'')'''
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''ID''
|-
:Integer. The ID number of the spare part pool to retrieve.
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the spare part pool to retrieve.
|}




Line 19: Line 15:
  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
   
  {{APIComment|'Get spare part pool #1 from project #1.}}
  {{APIComment|'Get spare part pool #1 from project #1.}}
  {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
  {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Set}} MyPool = MyRepository.Pool.GetPool(1)
  {{APIPrefix|Set}} MyPool = MyRepository.Pool.GetPool(1)
   
   
  {{APIComment|'Output sample: Display the name and ID of the pool.}}
  {{APIComment|'Output sample: Display the name and ID of the pool.}}
  {{APIPrefix|Dim}} PoolName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} PoolName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} PoolID {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} PoolID {{APIPrefix|As}} Integer
  PoolName = MyPool.Name
  PoolName = MyPool.Name
  PoolID = MyPool.ID
  PoolID = MyPool.ID
  MsgBox ({{APIString|"You got "}} & PoolName & {{APIString|", ID#"}} & PoolID)
  MsgBox ({{APIString|"You got "}} & PoolName & {{APIString|", ID#"}} & PoolID)


  '''VB.NET'''
  '''VB.NET'''
   
   
{{APIComment|'Add code to connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}   
  {{APIComment|...}}
   
   
   
  {{APIComment|'Get spare part pool #1 from project #1.}}
  {{APIComment|'Get spare part pool #1 from project #1.}}

Revision as of 20:48, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.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

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

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