Функция RtmHoldDestination (rtmv2.h)
Функция RtmHoldDestination помечает назначение, которое должно быть помещено в состояние удержания в течение определенного периода времени. Удержание происходит только в том случае, если последний маршрут для назначения в любом представлении удаляется.
Протоколы маршрутизации, использующие состояния удержания, продолжают объявлять последний маршрут до истечения срока удержания, даже если в это время поступают новые маршруты. Маршрут объявляется как удаленный. Однако новые маршруты используются протоколами маршрутизации для переадресации. Новые маршруты объявляются по истечении срока удержания.
Синтаксис
DWORD RtmHoldDestination(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_DEST_HANDLE DestHandle,
[in] RTM_VIEW_SET TargetViews,
[in] ULONG HoldTime
);
Параметры
[in] RtmRegHandle
Дескриптор клиента, полученного при предыдущем вызове RtmRegisterEntity.
[in] DestHandle
Дескриптор к месту назначения, чтобы пометить для удержания.
[in] TargetViews
Указывает представления, в которых будет храниться назначение.
[in] HoldTime
Указывает, как долго (в миллисекундах) будет храниться назначение.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.
Если функция завершается сбоем, возвращается один из следующих кодов ошибок.
| Значение | Значение |
|---|---|
|
Указанное время удержания равно нулю. |
|
Дескриптор недействителен. |
Комментарии
Все маршруты в состоянии удержания удерживаются для всех представлений в течение одного максимального времени удержания, независимо от указанного значения HoldTime .
Пример кода, использующий эту функцию, см. в разделе Использование состояния Hold-Down маршрута.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Ни одна версия не поддерживается |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | rtmv2.h |
| Библиотека | Rtm.lib |
| DLL | Rtm.dll |