Share via


ICluster::ModifyJob method

Modifies the specified job.

Syntax

HRESULT ModifyJob(
  [in] long jobId,
  [in] IJob *Job
);

Parameters

  • jobId [in]
    The job identifier. The ICluster::AddJob method returns this value. If you have an instance of the job that has already been added to the cluster, you can call the IJob::get_Id method to get the identifier.

  • Job [in]
    An IJob interface that contains the new properties of the job.

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.

Remarks

This method overwrites all the properties of the job specified in the jobId parameter with all the properties of the job specified in the Job parameter (the method does not update the tasks of the job, only its properties).

If the job is running, you must use the ICluster::ModifyJobTerm method to modify the job.

To modify single property values, call the ICluster::ModifyJobTerm method.

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

Ccpapi.tlb

See also

ICluster

ICluster::ModifyJobTerm