IClusterService.ListJobs Method (String, JobStatus, Boolean, Byte[], Byte , Int32)

Article
04/17/2009

This method supports the infrastructure and is not intended to be used directly from your code.

Retrieves all jobs in the cluster that were submitted by the specified owner and that have the specified status. The jobs are returned in blocks of jobs from a specified snapshot of the cluster.

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

Usage

Syntax

'Declaration
Function ListJobs ( _
    submittedBy As String, _
    status As JobStatus, _
    withTasks As Boolean, _
    timestamp As Byte(), _
    version As Byte(), _
    pageSize As Integer _
) As IJob()

IJob[] ListJobs (
    string submittedBy,
    JobStatus status,
    bool withTasks,
    byte[] timestamp,
    byte[] version,
    int pageSize
)

array<IJob^>^ ListJobs (
    String^ submittedBy, 
    JobStatus status, 
    bool withTasks, 
    array<unsigned char>^ timestamp, 
    array<unsigned char>^ version, 
    int pageSize
)

IJob[] ListJobs (
    String submittedBy, 
    JobStatus status, 
    boolean withTasks, 
    byte[] timestamp, 
    byte[] version, 
    int pageSize
)

function ListJobs (
    submittedBy : String, 
    status : JobStatus, 
    withTasks : boolean, 
    timestamp : byte[], 
    version : byte[], 
    pageSize : int
) : IJob[]

Parameters

submittedBy
The name of the user that submitted the job.

status

withTasks
Specify true to retrieve only jobs that contain tasks; otherwise, false.

timestamp

version

pageSize
The number of jobs to retrieve.

Return Value

An array of IJob interfaces. The array is empty when there are no jobs left 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