Repository.Pool.GetAllPools: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:Repository.GetAllPools.Cmt}}


==Syntax ==
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. 
*GetAllPools() {{APIPrefix|As}} [[cPool Class|cPool]]()
<noinclude>
== Syntax ==
''object''.'''Pool.GetAllPools()'''


== Usage Example ==
where ''object'' is a variable that represents a Repository object.
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
== Example ==
  Dim MyRepository As New Repository
This example assumes that spare part pools exist in the first available project of a repository.
 
 
  {{APIComment|'Connect to the Synthesis repository.}}
'''VBA|VB.NET'''
  Dim Success As Boolean = False
   
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Set a first available project as current.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIComment|'Get a list of all pools in project #1.}}
  {{APIPrefix|Dim}} ListofPools() {{APIPrefix|As}} cPool
   MyRepository.Project.SetCurrentProject (1) 
  ListofPools = MyRepository.Pool.GetAllPools()
   
   
  {{APIComment|'Get the list of pools in the current project.}}
  {{APIComment|'Output sample: Display the name and ID of the first available pool in the project.}}
   Dim ListOfPools() As [[cPool Class|cPool]]
   {{APIPrefix|Dim}} PoolName {{APIPrefix|As}} String
   ListOfPools = MyRepository.Pool.GetAllPools()
  {{APIPrefix|Dim}} PoolID {{APIPrefix|As}} Integer
</div>
   PoolName = ListofPools(0).Name
  PoolID = ListofPools(0).ID
  MsgBox ({{APIString|"The first spare part pool is: "}} & PoolName & {{APIString|", ID#"}} & PoolID)
</noinclude>

Revision as of 20:40, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

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

object.Pool.GetAllPools()

where object is a variable that represents a Repository object.

Example

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

VBA|VB.NET

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

 'Get a list of all 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 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Pool.GetAllPools&oldid=59434"