Scheduler.OpenJobEnumerator Method

Definition

Retrieves an enumerator that contains the jobs that match the filter criteria.

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

Parameters

properties
IPropertyIdCollection

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

filter
IFilterCollection

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

sort
ISortCollection

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

Returns

An ISchedulerRowEnumerator interface that you use to enumerate the results.

Implements

Attributes

Applies to