ICreateErrorInfo::SetDescription
This method sets a textual description of the error.
HRESULT SetDescription(
LPCOLESTR *szDescription);
Parameters
- szDescription
Brief, null-terminated string that describes the error.
Return Values
One of the values described in the following table is returned.
Value | 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 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
Runs on | Versions | Defined in | Include | Link to |
---|---|---|---|---|
Windows CE OS | 2.0 and later | Oaidl.h |
Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.