RpcTestCancel function

The RpcTestCancel function checks for a cancel indication.

Syntax

RPC_STATUS RPC_ENTRY RpcTestCancel(void);

Parameters

This function has no parameters.

Return value

It is not unusual for the RpcTestCancel function to return the value ERROR_ACCESS_DENIED. This indicates that the remote procedure call has not been canceled.

Remarks

An application server stub calls RpcTestCancel to determine whether a call has been canceled. If the call has been canceled, RPC_S_OK is returned; otherwise, another value is returned.

This function should be called periodically by the server stub so that it can respond to cancels in a timely fashion. If the function returns RPC_S_OK, the stub should clean up its data structures and return to the client.

Requirements

See also

RpcServerTestCancel