SchedulerJob.GetTaskList(IFilterCollection, ISortCollection, Boolean) Method

Definition

Retrieves a list of task objects based on the specified filters.

public Microsoft.Hpc.Scheduler.ISchedulerCollection GetTaskList (Microsoft.Hpc.Scheduler.IFilterCollection filter, Microsoft.Hpc.Scheduler.ISortCollection sort, bool expandParametric);
abstract member GetTaskList : Microsoft.Hpc.Scheduler.IFilterCollection * Microsoft.Hpc.Scheduler.ISortCollection * bool -> Microsoft.Hpc.Scheduler.ISchedulerCollection
override this.GetTaskList : Microsoft.Hpc.Scheduler.IFilterCollection * Microsoft.Hpc.Scheduler.ISortCollection * bool -> Microsoft.Hpc.Scheduler.ISchedulerCollection
Public Function GetTaskList (filter As IFilterCollection, sort As ISortCollection, expandParametric As Boolean) As ISchedulerCollection

Parameters

filter
IFilterCollection

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

sort
ISortCollection

An array of ISortCollection interface that contains a collection of 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 ISchedulerCollection interface that contains a collection of task identifiers (see ISchedulerTask) that meet the filter criteria.

Implements

Applies to