3.2.4.4.3.56 IVolumeClient3::HrGetErrorData (Opnum 67)

  • Article

The HrGetErrorData method retrieves user-readable error information associated with an HRESULT error code.

 HRESULT HrGetErrorData(
   [in] HRESULT hr,
   [in] DWORD dwFlags,
   [out] DWORD* pdwStoredFlags,
   [out] int* pcszw,
   [out, string, size_is(,*pcszw,)] 
     wchar_t*** prgszw
 );

hr: The HRESULT error code from which error information is retrieved.

dwFlags: Bitmap of retrieval flags. The value of this field is generated by combining zero or more of the following applicable flags with a logical OR operation.

Value

Meaning

ERRFLAG_NOREMOVE

0x00020000

Do not delete the error information from the list maintained by the server.

ERRFLAG_IGNORETAG

0x00040000

Retrieve the error information even if it was not produced for this client.

pdwStoredFlags: Pointer to a bitmap of error flags.<223>

pcszw: Pointer to the number of strings returned in prgszw.

prgszw: Pointer to an array of strings that contain error information for the HRESULT.

Return Values: The method MUST return 0 or a nonerror HRESULT on success, or an implementation-specific nonzero error code on failure (as specified in [MS-ERREF]; see also section 2.2.1 for HRESULT values predefined by the Disk Management Remote Protocol).

When the server receives an IVolumeClient3::HrGetErrorData message, it MUST process that message, as specified in IVolumeClient::HrGetErrorData (section 3.2.4.4.1.53).