IJob::SetExtendedJobTerm method

Sets the application-defined extended term on the job.

Syntax

HRESULT SetExtendedJobTerm(
  [in] BSTR Name,
  [in] BSTR Value
);

Parameters

  • Name [in]
    The name of the extended term to add. The term is limited to 80 Unicode characters.

  • Value [in]
    The value of the extended term. The value is limited to 1,024 Unicode characters.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

Remarks

Use this method to add or update your own terms that are passed to the submission and activation filters. For a list of predefined job terms, see the Remarks section of ICluster::ModifyJobTerm.

After adding the job to the cluster, use the ICluster::ModifyJobTerm to add or update the extended job terms.

To retrieve the current extended terms, call the IJob::get_ExtendedJobTerms method.

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

Ccpapi.tlb

See also

IJob

IJob::get_ExtendedJobTerms

ITask::SetExtendedTaskTerm