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