Cluster.ListJobs Method

Article
04/17/2009

Retrieves all jobs in the cluster that were submitted by the specified owner and that have the specified status.

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

Usage

Syntax

'Declaration
Public Function ListJobs ( _
    submittedBy As String, _
    status As JobStatus _
) As IClusterEnumerable

public IClusterEnumerable ListJobs (
    string submittedBy,
    JobStatus status
)

public:
virtual IClusterEnumerable^ ListJobs (
    String^ submittedBy, 
    JobStatus status
) sealed

public final IClusterEnumerable ListJobs (
    String submittedBy, 
    JobStatus status
)

public final function ListJobs (
    submittedBy : String, 
    status : JobStatus
) : IClusterEnumerable

Parameters

submittedBy
The name of the user that submitted the job. The name is in the form domain\username. If NULL, the method retrieves all jobs with the specified status.

status
The job status. For a list of values, see JobStatus.

Return Value

An IClusterEnumerable interface that contains the collection IJob interfaces. The enumerable object is empty when there are no jobs 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