RpcAsyncGetCallStatus function (rpcasync.h)

Article
02/22/2024

The client calls the RpcAsyncGetCallStatus function to determine the current status of an asynchronous remote call.

Syntax

RPC_STATUS RpcAsyncGetCallStatus(
  PRPC_ASYNC_STATE pAsync
);

Parameters

pAsync

Pointer to the RPC_ASYNC_STATE structure that contains asynchronous call information.

Return value

Value	Meaning
RPC_S_OK	The call was completed successfully.
RPC_S_INVALID_ASYNC_HANDLE	The asynchronous call handle is not valid.
RPC_S_ASYNC_CALL_PENDING	The call has not yet completed.
Other error codes	The call failed. The client application must call RpcAsyncCompleteCall to receive the application-specific error code.

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

Remarks

This client-side function returns the current status of the asynchronous call. Note that if the return value is anything other than RPC_S_ASYNC_CALL_PENDING the call is complete.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	rpcasync.h (include Rpc.h)
Library	Rpcrt4.lib
DLL	Rpcrt4.dll