ISchedulerJob.OpenTaskEnumerator Method

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


Namespace: Microsoft.Hpc.Scheduler
Assembly: Microsoft.Hpc.Scheduler (in Microsoft.Hpc.Scheduler.dll)

'Usage
Dim instance As ISchedulerJob
Dim properties As IPropertyIdCollection
Dim filter As IFilterCollection
Dim sort As ISortCollection
Dim expandParametric As Boolean
Dim returnValue As ISchedulerRowEnumerator

returnValue = instance.OpenTaskEnumerator(properties, filter, sort, expandParametric)

[ComVisibleAttribute(false)] 
ISchedulerRowEnumerator OpenTaskEnumerator (
	IPropertyIdCollection properties,
	IFilterCollection filter,
	ISortCollection sort,
	bool expandParametric
)
/** @attribute ComVisibleAttribute(false) */ 
ISchedulerRowEnumerator OpenTaskEnumerator (
	IPropertyIdCollection properties, 
	IFilterCollection filter, 
	ISortCollection sort, 
	boolean expandParametric
)
ComVisibleAttribute(false) 
function OpenTaskEnumerator (
	properties : IPropertyIdCollection, 
	filter : IFilterCollection, 
	sort : ISortCollection, 
	expandParametric : boolean
) : ISchedulerRowEnumerator

Parameters

properties

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

filter

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

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

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

Return Value

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

A property can be null if the property has not been set. Check that the property object is valid before accessing its value.

If you specify more than one filter, a logical AND is applied to the filters. For example, return tasks that are running and have exclusive access to the nodes.

Only the job owner or administrator can enumerate the tasks in a job. The job must have been added to the scheduler before calling this method.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012

Target Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2003 R2, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, with HPC Pack Client Utilities




Build Date:

2013-04-22

Community Additions

ADD
Show: