RpcMgmtInqComTimeout function (rpcdce.h)

Article
04/02/2021

The RpcMgmtInqComTimeout function returns the binding-communications time-out value in a binding handle.

Syntax

RPC_STATUS RpcMgmtInqComTimeout(
  RPC_BINDING_HANDLE Binding,
  unsigned int       *Timeout
);

Parameters

Binding

Specifies a binding.

Timeout

Returns a pointer to the time-out value from the Binding parameter.

Return value

Value	Meaning
RPC_S_OK	The call succeeded.
RPC_S_INVALID_BINDING	The binding handle was invalid.
RPC_S_WRONG_KIND_OF_BINDING	This was the wrong kind of binding for the operation.

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

Remarks

A client application calls RpcMgmtInqComTimeout to view the time-out value in a server binding handle. The time-out value specifies the relative amount of time that should be spent to wait for a response from the server before giving up. For a table of the time-out values, see Binding Time-out Constants. For more information on how the COM time-out operates, and when to use it, see RPC and the Network.

A client also calls RpcMgmtSetComTimeout to change the time-out value.

Requirements

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