RpcErrorSaveErrorInfo function

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

Syntax

RPC_STATUS  RPC_ENTRY RpcErrorSaveErrorInfo(
  _In_  RPC_ERROR_ENUM_HANDLE *EnumHandle,
  _Out_ PVOID                 *ErrorBlob,
  _Out_ size_t                *BlobSize
);

Parameters

EnumHandle [in]

Pointer to the enumeration handle.

ErrorBlob [out]

Pointer to the BLOB containing the error information.

BlobSize [out]

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.

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

See also

Obtaining Extended RPC Error Information

RPC_ERROR_ENUM_HANDLE

RpcErrorStartEnumeration

RpcErrorLoadErrorInfo