Repository.Pool.GetPool: Difference between revisions
Jump to navigation
Jump to search
Alex Ulanov (talk | contribs) |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template: | <noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude> | ||
{{Template:Repository | |||
==Syntax== | 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> | |||
== Syntax == | |||
''object''.'''Pool.GetPool(''ID'')''' | |||
where ''object'' is a variable that represents a Repository object. | |||
=== Parameters === | |||
{| {{APITable}} | |||
|- | |||
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the spare part pool to retrieve. | |||
|} | |||
== | |||
{{APIComment|' | == Example == | ||
Dim | This example assumes that a spare part pool with ID#1 exists in a repository. | ||
'''VBA''' | |||
{{APIComment|' | |||
Dim | {{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.}} | ||
MyRepository.Project.SetCurrentProject( | {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool | ||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIPrefix|Set}} 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) | |||
'''VB.NET''' | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...'Add code to connect to a Synthesis repository.}} | |||
{{APIComment|'Get spare part pool #1 from project #1.}} | |||
{{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool | |||
MyRepository.Project.SetCurrentProject(1) | |||
MyPool = MyRepository.Pool.GetPool(1) | |||
{{APIComment|' | {{APIComment|'Output sample: Display the name and ID of the pool.}} | ||
Dim | {{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) | |||
</noinclude> | |||
Revision as of 23:02, 16 July 2015
 |
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)