Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

RpcServerTestCancel function

The server calls RpcServerTestCancel to test for client cancel requests.

Syntax


RPC_STATUS RPC_ENTRY RpcServerTestCancel(
  RPC_BINDING_HANDLE BindingHandle
);

Parameters

BindingHandle

Call to test for cancel commands. If a value of zero is specified, the server impersonates the client that is being served by this server thread.

Return value

ValueMeaning
RPC_S_OK

The call was canceled by the client. The server must still complete or abort the call.

RPC_S_NO_CALL_ACTIVE

There is no active call on the current thread.

RPC_S_CALL_IN_PROGRESS

The call was not canceled.

RPC_S_INVALID_BINDING

The handle is not valid.

 

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

Remarks

The server calls RpcServerTestCancel to find out if the client has requested cancelation of an outstanding call. The RpcServerTestCancel function only indicates whether a client has canceled the call; state is not changed on the server or client. The canceled call must still be completed or aborted by the RPC server, using RpcAsyncCompleteCall or RpcAsyncAbortCall function calls, respectively.

The BindingHandle parameter specifies the call on which to test. If the parameter has a value of zero, the call on the current thread is tested. The server can call the RpcServerTestCancel(RpcAsyncGetCallHandle(pAsync)) function to test for a cancel message using the asynchronous handle to obtain the binding handle.

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

Asynchronous RPC
RPC_ASYNC_STATE
RpcAsyncAbortCall
RpcAsyncCancelCall
RpcAsyncCompleteCall
RpcAsyncGetCallHandle
RpcAsyncGetCallStatus
RpcAsyncInitializeHandle

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.