RtmMarkDestForChangeNotification function (rtmv2.h)

The RtmMarkDestForChangeNotification function marks a destination for a client. A marked destination indicates to the routing table manager that it should send the client change notification messages for the marked destination. The client receives change notification messages when a destination changes. The change notifications inform the client of changes to best-route information for the specified destination. This function should be used when RtmRegisterForChangeNotification is called to request changes for specific destinations (RTM_NOTIFY_ONLY_MARKED_DESTS).

Syntax

DWORD RtmMarkDestForChangeNotification(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_NOTIFY_HANDLE NotifyHandle,
  [in] RTM_DEST_HANDLE   DestHandle,
  [in] BOOL              MarkDest
);

Parameters

[in] RtmRegHandle

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

[in] NotifyHandle

Handle to a change notification obtained via a previous call to RtmRegisterForChangeNotification.

[in] DestHandle

Handle to the destination that the client is marking for notification of changes.

[in] MarkDest

Specifies whether to mark a destination and receive change notifications. Specify TRUE to mark a destination and start receive change notifications for the specified destination. Specify FALSE to stop receiving change notifications a previously marked destination.

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.

 

 

Requirements

Requirement	Value
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

RtmGetChangeStatus

RtmGetChangedDests

RtmIgnoreChangedDests

RtmIsMarkedForChangeNotification

RtmRegisterForChangeNotification

RtmReleaseChangedDests