ICluster::ListJobs method

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

Syntax


HRESULT ListJobs(
  [in]  BSTR               SubmittedBy,
  [in]  JobStatus          Status,
  [out] IClusterEnumerable **pRetVal
);

Parameters

SubmittedBy [in]

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

Status [in]

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

pRetVal [out]

An IClusterEnumerable interface that contains the collection of jobs. To retrieve the list of IJob interfaces, use the IClusterEnumerable::GetEnumerator method. The variant type of each item is VT_DISPATCH. Query the pdispVal member of the variant for the IJob interface. The enumerable object is empty when there are no jobs to return.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code. To get a description of the error, call the ICluster::get_ErrorMessage method.

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

Ccpapi.tlb

See also

ICluster
ICluster::ListAllJobs
ICluster::ListJobsWithPaging
ICluster::ListTasks

 

 

Show: