SchedulerJob.GetTaskIdList Method

Reference

Definition

Namespace:: Microsoft.Hpc.Scheduler

Assembly:: Microsoft.Hpc.Scheduler.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public Microsoft.Hpc.Scheduler.ISchedulerCollection GetTaskIdList (Microsoft.Hpc.Scheduler.IFilterCollection filter, Microsoft.Hpc.Scheduler.ISortCollection sort, bool expandParametric);

abstract member GetTaskIdList : Microsoft.Hpc.Scheduler.IFilterCollection * Microsoft.Hpc.Scheduler.ISortCollection * bool -> Microsoft.Hpc.Scheduler.ISchedulerCollection
override this.GetTaskIdList : Microsoft.Hpc.Scheduler.IFilterCollection * Microsoft.Hpc.Scheduler.ISortCollection * bool -> Microsoft.Hpc.Scheduler.ISchedulerCollection

Public Function GetTaskIdList (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

ISchedulerCollection

An ISchedulerCollection interface that contains a collection of task identifiers (see ITaskId) that meet the filter criteria.

Implements

Applies to