Repository.Pool.GetAllPools: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo 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 a list of all existing spare part pools in the current project. Returns a '''[[CPool Class|cPool]]''' object array that contains the spare part pool names, ID numbers and other information.   
Gets a list of all existing spare part pools in the current project. Returns a '''[[CPool Class|cPool]]''' object array that contains the spare part pool names, ID numbers and other information.   
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Pool.GetAllPools()'''
'''.Pool.GetAllPools()'''


where ''object'' is a variable that represents a Repository object.


== Example ==
== Example ==
Line 13: Line 13:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{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 a list of all spare part pools in project #1.}}
  {{APIComment|'Get a list of all spare part pools in project #1.}}
   {{APIPrefix|Dim}} ListofPools() {{APIPrefix|As}} cPool
   {{APIPrefix|Dim}} ListofPools() {{APIPrefix|As}} cPool

Revision as of 18:16, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of all existing spare part pools in the current project. Returns a cPool object array that contains the spare part pool names, ID numbers and other information.

Syntax

.Pool.GetAllPools()


Example

This example assumes that spare part pools exist in the first available project of a repository.

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 
 'Get a list of all spare part pools in project #1. 
 Dim ListofPools() As cPool
 MyRepository.Project.SetCurrentProject (1)  
 ListofPools = MyRepository.Pool.GetAllPools()

 'Output sample: Display the name and ID of the first available spare part pool in the project. 
 Dim PoolName As String
 Dim PoolID As Integer
 PoolName = ListofPools(0).Name
 PoolID = ListofPools(0).ID
 MsgBox ("The first spare part pool is: " & PoolName & ", ID#" & PoolID)