ICreateErrorInfo::SetDescription

  • Article

This method sets a textual description of the error.

HRESULT SetDescription( 
  LPCOLESTR* szDescription
);

Parameters

  • szDescription
    [in] Brief, null-terminated string that describes the error.

Return Values

If the method succeeds, the return value is S_OK.

If there is insufficient memory to complete the operation, the return value is E_OUTOFMEMORY.

Remarks

The text should be supplied in the language specified by the locale identifier (LCID) that was passed to the method raising the error.

Example

hr = CreateErrorInfo(&pcerrinfo);
if (m_excepinfo.bstrDescription)
 pcerrinfo->SetDescription(m_excepinfo.bstrDescription);

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Oaidl.h, Oaidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.

See Also

ICreateErrorInfo

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.