Repository.Pool.GetPool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetPool.Cmt}}


==Syntax==
* GetPool({{APIPrefix|As}} [[cPool Class|cPool]])


Parameters
<onlyinclude>Returns a '''[[CPool Class|cPool]]''' object that represents a given spare part pool resource in the current project. Returns nothing if the spare part pool does not exist or is not in the current project.</onlyinclude>


Enter the Pool ID to get desired pool.
== Syntax ==
'''.Pool.GetPool'''(''ID'')


== Usage Example ==
=== Parameters ===
  {{APIComment|'Declare a new repository connection object.}}
''ID''
  Dim MyRepository As New Repository
: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'''
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIComment|'Get spare part pool #1 from project #1.}}
  Dim Success As Boolean = False
  {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  MyRepository.Project.SetCurrentProject(1)
 
  {{APIPrefix|Set}} MyPool = MyRepository.Pool.GetPool(1)
  {{APIComment|'Get the list of pools in the connected repository.}}
  Dim ListOfPools() As [[cPool Class|cPool]]
  {{APIComment|'Output sample: Display the name and ID of the pool.}}
  ListOfPools = MyRepository.GetAllPools()
  {{APIPrefix|Dim}} PoolName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} PoolID {{APIPrefix|As}} Integer
  PoolName = MyPool.Name
  PoolID = MyPool.ID
  MsgBox ({{APIString|"You got "}} & PoolName & {{APIString|", ID#"}} & PoolID)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Get a Pool.}}
  {{APIComment|'Get spare part pool #1 from project #1.}}
   Dim GetPool() as cPool
   {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
   GetPool= MyRepository.GetPool(1)
  MyRepository.Project.SetCurrentProject(1)
   MyPool = MyRepository.Pool.GetPool(1)
{{APIComment|'Output sample: Display the name and ID of the pool.}}
  {{APIPrefix|Dim}} PoolName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} PoolID {{APIPrefix|As}} Integer
  PoolName = MyPool.Name
  PoolID = MyPool.ID
  MsgBox ({{APIString|"You got "}} & PoolName & {{APIString|", ID#"}} & PoolID)

Latest revision as of 18:54, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a cPool object that represents a given spare part pool resource in the current project. 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

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 '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

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 '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)