Share via

IRecoverableErrorData::GetErrorDescription

  • Article

Gets the description of the error.

Syntax

HRESULT GetErrorDescription(
  LPWSTR pszErrorDescription,
  DWORD * pcchErrorDescription);

Parameters

  • pszErrorDescription
    [in, out, unique, string, size_is(*pcchErrorDescription)] Returns the description of the error.

  • pcchErrorDescription
    [in, out] 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

  • S_OK

  • E_POINTER

  • HRESULT_FROM_WIN32(ERROR_MORE_DATA) when pszErrorDescription is too small. In this case, the required number of characters is returned in pcchErrorDescription.

  • Provider-determined error codes

See Also

Reference

IRecoverableErrorData Interface