Edit

IRpcOptions::Query method (objidl.h)

  • Article

Retrieves the value of an RPC binding option property.

Syntax

HRESULT Query(
  [in]  IUnknown          *pPrx,
  [in]  RPCOPT_PROPERTIES dwProperty,
  [out] ULONG_PTR         *pdwValue
);

Parameters

[in] pPrx

A pointer to the proxy whose property is being queried.

[in] dwProperty

An identifier of the property to be queried, which must be COMBND_RPCTIMEOUT or COMBND_SERVER_LOCALITY (this flag is available starting with Windows Server 2003.)

[out] pdwValue

A pointer to the property value.

Return value

This method can return the standard return values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, E_FAIL, and S_OK.

Remarks

While the COMBND_RPCTIMEOUT property can also be set using the Set method, the COMBND_SERVER_LOCALITY property can only be queried.

See IRpcOptions for a table of the possible values of the COMBND_RPCTIMEOUT property.

The possible values of the COMBND_SERVER_LOCALITY property, which describes the degree of remoteness of the RPC connection, are enumerated in the following table.

Value Description
SERVER_LOCALITY_PROCESS_LOCAL The counterpart is in the same process as the client.
SERVER_LOCALITY_MACHINE_LOCAL The counterpart is on the same computer as the client but in a different process.
SERVER_LOCALITY_REMOTE The counterpart is on a remote computer.

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 objidl.h (include ObjIdl.h)

See also

IRpcOptions