RtmGetOpaqueInformationPointer function (rtmv2.h)

The RtmGetOpaqueInformationPointer function returns a pointer to the opaque information field in a destination that is reserved for this client. The pointer enables the client to store client-specific information with the destination in the routing table.

Syntax

DWORD RtmGetOpaqueInformationPointer(
  RTM_ENTITY_HANDLE RtmRegHandle,
  RTM_DEST_HANDLE   DestHandle,
  PVOID             *OpaqueInfoPointer
);

Parameters

RtmRegHandle

Handle to the client obtained from a previous call to RtmRegisterEntity.

DestHandle

Handle to the destination.

OpaqueInfoPointer

On input, OpaqueInfoPointer is a pointer to NULL.

On output, OpaqueInfoPointer receives a pointer to the opaque information pointer. If a client has not reserved an opaque pointer during registration, this parameter remains unchanged.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_INVALID_HANDLE
The handle is invalid.
ERROR_NOT_FOUND
No opaque pointer was reserved by the client.
 
 

Remarks

For sample code using this function, see Access the Opaque Pointer in a Destination.

Requirements

   
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header rtmv2.h
Library Rtm.lib
DLL Rtm.dll

See also

RtmLockDestination