CScheduledTask.GetPools Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{DISPLAYTITLE:cScheduledTask.GetPools Method}}{{Template:API}}{{Template:APIBreadcrumb|.cScheduledTask}} <onlyinclude>Returns an array of the Pool IDs…')
 
No edit summary
 
Line 8: Line 8:


== Syntax ==
== Syntax ==
  '''.GetPools'''(''arr()'')
  '''.GetPools'''({{APIPrefix|ByRef}} ''arr()'')


===Parameters===
===Parameters===

Latest revision as of 18:37, 10 August 2018

APIWiki.png


Member of: SynthesisAPI.cScheduledTask


Returns an array of the Pool IDs and number of parts for all pools required for the task.


Remarks: Alternatively, .NET users can use the Pools() property in the class to get or set the Pools IDs and number of parts.

Syntax

.GetPools(ByRef arr())

Parameters

arr()

Required as PoolInfo. An array of the Pool IDs and the number of parts for all pools required for the task.


Example

VBA

 ... 

 'Add code to get an existing scheduled task. 
 Dim aTask As cScheduledTask
 ... 

 'Get the IDs of the crews assigned to the task. 
 Dim myarray() As PoolInfo
 Call aTask.GetPools(myarray)

 'Sample output. 
 Dim i As Integer
 Dim upper As Integer
 Dim lower As Integer

 lower = LBound(myarray)
 upper = UBound(myarray)

 For i = lower To upper
  MsgBox "Pool ID = " & myarray(i).ID &". Number of Parts = " & myarray(i).NumParts
 Next i