SchedulerJob.OpenTaskEnumerator Method

Definition

Retrieves a rowset enumerator that contains the tasks that match the filter criteria.

[System.Runtime.InteropServices.ComVisible(false)]
public Microsoft.Hpc.Scheduler.ISchedulerRowEnumerator OpenTaskEnumerator (Microsoft.Hpc.Scheduler.IPropertyIdCollection properties, Microsoft.Hpc.Scheduler.IFilterCollection filter, Microsoft.Hpc.Scheduler.ISortCollection sort, bool expandParametric);
abstract member OpenTaskEnumerator : Microsoft.Hpc.Scheduler.IPropertyIdCollection * Microsoft.Hpc.Scheduler.IFilterCollection * Microsoft.Hpc.Scheduler.ISortCollection * bool -> Microsoft.Hpc.Scheduler.ISchedulerRowEnumerator
override this.OpenTaskEnumerator : Microsoft.Hpc.Scheduler.IPropertyIdCollection * Microsoft.Hpc.Scheduler.IFilterCollection * Microsoft.Hpc.Scheduler.ISortCollection * bool -> Microsoft.Hpc.Scheduler.ISchedulerRowEnumerator
Public Function OpenTaskEnumerator (properties As IPropertyIdCollection, filter As IFilterCollection, sort As ISortCollection, expandParametric As Boolean) As ISchedulerRowEnumerator

Parameters

properties
IPropertyIdCollection

An IPropertyIdCollection interface that contains a collection of the task properties that you want to include for each task in the enumerator.

filter
IFilterCollection

An IFilterCollection interface that contains one or more filter properties used to filter the list of tasks. If null, the method returns all tasks.

sort
ISortCollection

An ISortCollection interface that contains one or more sort properties used to sort the list of tasks. If null, the list is not sorted.

expandParametric
Boolean

Set to true to include parametric instances in the results; otherwise, false.

Returns

An ISchedulerRowEnumerator interface that you can use to enumerate the results.

Implements

Attributes

Applies to