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