RtmIgnoreChangedDests function (rtmv2.h)

Article
02/22/2024

The RtmIgnoreChangedDests function skips the next change for each destination if it has already occurred. This function can be used after RtmGetChangeStatus to prevent the routing table manager returning this change in response to a call to RtmGetChangedDests.

Syntax

DWORD RtmIgnoreChangedDests(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_NOTIFY_HANDLE NotifyHandle,
  [in] UINT              NumDests,
  [in] PRTM_DEST_HANDLE  ChangedDests
);

Parameters

[in] RtmRegHandle

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

[in] NotifyHandle

Handle to a change notification.

[in] NumDests

Specifies the number of destinations in ChangedDests.

[in] ChangedDests

Pointer to an array of RTM_DEST_HANDLE handles that indicate the destinations for which to ignore any pending changes.

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.

Remarks

When the destinations are no longer required, release them by calling RtmReleaseChangedDests.

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