Repository.Pool.GetAllPools: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
 
 
<onlyinclude>Returns an array of '''[[CPool Class|cPool]]''' objects that represent the spare part pools in the current project.</onlyinclude>


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>
== Syntax ==
== Syntax ==
''object''.'''Pool.GetAllPools()'''
'''.Pool.GetAllPools'''(''Filter'')
 
===Parameters===
''Filter''
:Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.


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


== Example ==
== Example ==
Line 13: Line 17:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  {{APIComment|'Get a list of all spare part pools in project #1.}}
 
  {{APIComment|'Get a list of all local spare part pools in project #1.}}
   {{APIPrefix|Dim}} ListofPools() {{APIPrefix|As}} cPool
   {{APIPrefix|Dim}} ListofPools() {{APIPrefix|As}} cPool
   MyRepository.Project.SetCurrentProject (1)   
   MyRepository.Project.SetCurrentProject (1)   
   ListofPools = MyRepository.Pool.GetAllPools()
   ListofPools = MyRepository.Pool.GetAllPools()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available spare part pool in the project.}}
  {{APIComment|'Output sample: Display the number of pools in the project.}}
   {{APIPrefix|Dim}} PoolName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} PoolID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1
   PoolName = ListofPools(0).Name
   MsgBox (NumberofElements)
  PoolID = ListofPools(0).ID
   MsgBox ({{APIString|"The first spare part pool is: "}} & PoolName & {{APIString|", ID#"}} & PoolID)
</noinclude>

Latest revision as of 18:54, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of cPool objects that represent the spare part pools in the current project.

Syntax

.Pool.GetAllPools(Filter)

Parameters

Filter

Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local resources only.


Example

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

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get a list of all local spare part pools in project #1. 
 Dim ListofPools() As cPool
 MyRepository.Project.SetCurrentProject (1)  
 ListofPools = MyRepository.Pool.GetAllPools()

 'Output sample: Display the number of pools in the project. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofPools) - LBound(ListofPools) + 1
 MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Pool.GetAllPools&oldid=64319"