RpcErrorSaveErrorInfo function (rpcasync.h)

The RpcErrorSaveErrorInfo function returns all error information for an enumeration handle as a BLOB.

Syntax

RPC_STATUS RpcErrorSaveErrorInfo(
  [in]  RPC_ERROR_ENUM_HANDLE *EnumHandle,
  [out] PVOID                 *ErrorBlob,
  [out] size_t                *BlobSize
);

Parameters

[in] EnumHandle

Pointer to the enumeration handle.

[out] ErrorBlob

Pointer to the BLOB containing the error information.

[out] BlobSize

Size of ErrorBlob, in bytes.

Return value

Successful completion returns RPC_S_OK. The RpcErrorSaveErrorInfo function call may fail if not enough memory is available.

Note  For a list of valid error codes, see RPC Return Values.
 

Remarks

The BLOB is allocated on the system heap, and the caller is the owner of the buffer. The block allocated on the system heap may be larger than BlobSize, but only BlobSize is used. The RpcErrorSaveErrorInfo function saves the entire chain of extended error information records associated with the enumeration handle, regardless of cursor position, and does not change the cursor position for the enumeration.

The BLOB may be saved and later retrieved using the RpcErrorLoadErrorInfo function.

Requirements

   
Minimum supported client Windows XP [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 [desktop apps | UWP apps]
Target Platform Windows
Header rpcasync.h (include Rpc.h)
Library Rpcrt4.lib
DLL Rpcrt4.dll

See also

Obtaining Extended RPC Error Information

RPC_ERROR_ENUM_HANDLE

RpcErrorLoadErrorInfo

RpcErrorStartEnumeration