Edit

Share via

IRecoverableErrorData::GetErrorDescription method (winsync.h)

  • Article

Gets the description of the error.

Syntax

HRESULT GetErrorDescription(
  [in, out] LPWSTR pszErrorDescription,
  [in, out] DWORD  *pcchErrorDescription
);

Parameters

[in, out] pszErrorDescription

Returns the description of the error.

[in, out] pcchErrorDescription

Specifies the number of characters in pszErrorDescription. Returns the required number of characters for pszErrorDescription when pcchErrorDescription is too small; otherwise, returns the number of characters written.

Return value

The possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
S_OK
 The method succeeded.
E_POINTER
 Invalid pointer.
HRESULT_FROM_WIN32(ERROR_MORE_DATA)
 pszErrorDescription is too small. In this case, the required number of characters is returned in pcchErrorDescription.
Provider-determined error codes.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header winsync.h

See also

IRecoverableErrorData Interface