ISettingsEngine::GetErrorDescription method (wcmconfig.h)

Retrieves a text message for a returned HRESULT code.

Syntax

HRESULT GetErrorDescription(
  [in]  LONG HResult,
  [out] BSTR *Message
);

Parameters

[in] HResult

The HRESULT code for which this method retrieves the error description.

[out] Message

The text message that corresponds to the HRESULT code.

Return value

This method returns an HRESULT value. S_OK indicates success. It may return E_OUTOFMEMORY if there are insufficient resources to allocate the string returned in the message.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wcmconfig.h
DLL SMIEngine.dll

See also

ISettingsEngine