Repository.Pool.GetPool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




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.  
<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>  
<noinclude>
 
== Syntax ==
== Syntax ==
  '''.Pool.GetPool'''(''ID'')
  '''.Pool.GetPool'''(''ID'')
=== Parameters ===
=== Parameters ===
''ID''
''ID''
:Integer. The ID number of the spare part pool to retrieve.
:Required. Integer. The ID number of the spare part pool to retrieve.




== Example ==
== Example ==
This example assumes that a spare part pool with ID#1 exists in a repository.
This example assumes that a spare part pool with ID #1 exists in the first project of a Synthesis repository.
  '''VBA'''
  '''VBA'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{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
Line 34: Line 34:
  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{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
Line 50: Line 49:
   PoolID = MyPool.ID
   PoolID = MyPool.ID
   MsgBox ({{APIString|"You got "}} & PoolName & {{APIString|", ID#"}} & PoolID)
   MsgBox ({{APIString|"You got "}} & PoolName & {{APIString|", ID#"}} & PoolID)
</noinclude>

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)