ITask::get_ErrorMessage method

  • Article

Retrieves the task error message.

Syntax

HRESULT get_ErrorMessage(
  [out] BSTR *pRetVal
);

Parameters

  • pRetVal [out]
    The task error message.

Return value

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

Remarks

The message contains the last message that was set for the task. The message can be a run-time error message or the message passed to the ICluster::CancelTask method.

Check the message if the task status is TaskStatus_Failed or TaskStatus_Cancelled.

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

 Ccpapi.tlb

See also

ICluster::CancelTask

ICluster::get_ErrorMessage

IJob::get_ErrorMessage

ITask