nf-rtmv2-rtmgetopaqueinformationpointer.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:rtmv2.RtmGetOpaqueInformationPointer	RtmGetOpaqueInformationPointer function (rtmv2.h)	The RtmGetOpaqueInformationPointer function returns a pointer to the opaque information field in a destination that is reserved for this client.	RtmGetOpaqueInformationPointer RtmGetOpaqueInformationPointer function [RAS] _rtmv2ref_rtmgetopaqueinformationpointer rras.rtmgetopaqueinformationpointer rtmv2/RtmGetOpaqueInformationPointer	rras\rtmgetopaqueinformationpointer.htm	RRAS	7ad948fa-cd00-4496-bd62-433d7faa0f85	12/05/2018	RtmGetOpaqueInformationPointer, RtmGetOpaqueInformationPointer function [RAS], _rtmv2ref_rtmgetopaqueinformationpointer, rras.rtmgetopaqueinformationpointer, rtmv2/RtmGetOpaqueInformationPointer	rtmv2.h		Windows	None supported	Windows 2000 Server [desktop apps only]										Rtm.lib	Rtm.dll		Windows			19H1	RtmGetOpaqueInformationPointer rtmv2/RtmGetOpaqueInformationPointer	c++	APIRef kbSyntax	DllExport	Rtm.dll	RtmGetOpaqueInformationPointer

RtmGetOpaqueInformationPointer function

-description

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.

-parameters

-param RtmRegHandle [in]

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

-param DestHandle [in]

Handle to the destination.

-param OpaqueInfoPointer [out]

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.

-returns

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.

-see-also

RtmLockDestination