Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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 |
|---|---|
|
The method succeeded. |
|
Invalid pointer. |
|
pszErrorDescription is too small. In this case, the required number of characters is returned in pcchErrorDescription. |
|
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 |