RpcErrorResetEnumeration function (rpcasync.h)

Article
02/22/2024

The RpcErrorResetEnumeration function resets an enumeration cursor for any in-process enumeration, resetting the process such that a subsequent call to the RpcErrorGetNextRecord retrieves the first extended error information record.

Syntax

RPC_STATUS RpcErrorResetEnumeration(
  RPC_ERROR_ENUM_HANDLE *EnumHandle
);

Parameters

EnumHandle

Pointer to the enumeration handle.

Return value

Successful completion returns RPC_S_OK. The RpcErrorResetEnumeration function call cannot fail unless its parameters are invalid.

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

Remarks

The RpcErrorResetEnumeration function call can reset an enumeration of extended error information even if the RpcErrorGetNextRecord function reaches the end of enumerations and returns RPC_S_SNTRY_NOT_FOUND.

Requirements

Requirement	Value
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