RtmHoldDestination function (rtmv2.h)
The RtmHoldDestination function marks a destination to be put in the hold-down state for a certain amount of time. A hold down only happens if the last route for the destination in any view is deleted.
Routing protocols that use hold-down states continue to advertise the last route until the hold-down expires, even if newer routes arrive in the meantime. The route is advertised as a deleted route. The newer routes are, however, used by the routing protocols for forwarding purposes. New routes are advertised when the hold down expires.
Syntax
DWORD RtmHoldDestination(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_DEST_HANDLE DestHandle,
[in] RTM_VIEW_SET TargetViews,
[in] ULONG HoldTime
);
Parameters
[in] RtmRegHandle
Handle to the client obtained from a previous call to RtmRegisterEntity.
[in] DestHandle
Handle to the destination to mark for holding.
[in] TargetViews
Specifies the views in which to hold the destination.
[in] HoldTime
Specifies how long, in milliseconds, to hold the 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 |
|---|---|
|
The hold time specified was zero. |
|
The handle is invalid. |
Remarks
All routes in a hold-down state are held for all views for a single, maximum hold-down time, regardless of the HoldTime specified.
For sample code using this function, see Use the Route Hold-Down State.
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 |