Cluster.ListTasks Method

Article
04/17/2009

Retrieves all tasks in the specified job.

Namespace: Microsoft.ComputeCluster
Assembly: CcpAPI (in ccpapi.dll)

Usage

Syntax

'Declaration
Public Function ListTasks ( _
    jobId As Integer _
) As IClusterEnumerable

public IClusterEnumerable ListTasks (
    int jobId
)

public:
virtual IClusterEnumerable^ ListTasks (
    int jobId
) sealed

public final IClusterEnumerable ListTasks (
    int jobId
)

public final function ListTasks (
    jobId : int
) : IClusterEnumerable

Parameters

jobId
The identifier of the job whose tasks you want to retrieve. The Cluster.AddJob method returns this value. If you have a job object that has already been added to the cluster, you can access the Job.Id property to get the identifier.

Return Value

An IClusterEnumerable interface that contains a collection of ITask interfaces. The enumerable object is empty when there are no tasks to return.

Thread Safety

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

Platforms

Development Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003, Windows XP

Target Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003 with Compute Cluster Pack Client Utilities, Windows XP with Compute Cluster Pack Client Utilities