ITask::SetExtendedTaskTerm method

Sets the application-defined extended term for the task.

Syntax

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

Parameters

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

  • Value [in]
    The value of the task 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 define your own task terms that are passed to the submission and activation filters as part of the XML.

To retrieve the current extended terms, call the ITask::get_ExtendedTaskTerms method.

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

Ccpapi.tlb

See also

IJob::SetExtendedJobTerm

ITask

ITask::get_ExtendedTaskTerms