Edit

ICreateErrorInfo::SetDescription method (oaidl.h)

  • Article

Sets the textual description of the error.

Syntax

HRESULT SetDescription(
  [in] LPOLESTR szDescription
);

Parameters

[in] szDescription

A brief description of the error.

Return value

This method can return one of these values.

Return code Description
S_OK
 Success.
E_OUTOFMEMORY
 Insufficient memory to complete the operation.

Remarks

The text should be supplied in the language specified by the locale ID (LCID) that was passed to the method raising the error. For more information, see LCID Attribute in Type Libraries and the Object Description Language.

Use of this function is demonstrated in the file Main.cpp of the COM Fundamentals Hello sample.

Requirements

Requirement Value
Target Platform Windows
Header oaidl.h

See also

ICreateErrorInfo