Expand Minimize

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

ValueMeaning
RPC_S_OK

The call has been canceled.

Other values

The call has not been canceled.

 

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

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Rpcdce.h (include Rpc.h)

Library

Rpcrt4.lib

DLL

Rpcrt4.dll

See also

RpcServerTestCancel

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.