Поделиться через


Функция RtmInsertInRouteList (rtmv2.h)

Функция RtmInsertInRouteList вставляет указанный набор маршрутов в список маршрутов клиента. Если маршрут уже находится в другом списке, он удаляется из старого списка и вставляется в новый.

Синтаксис

DWORD RtmInsertInRouteList(
  [in] RTM_ENTITY_HANDLE     RtmRegHandle,
  [in] RTM_ROUTE_LIST_HANDLE RouteListHandle,
  [in] UINT                  NumRoutes,
  [in] PRTM_ROUTE_HANDLE     RouteHandles
);

Параметры

[in] RtmRegHandle

Дескриптор клиента, полученного при предыдущем вызове RtmRegisterEntity.

[in] RouteListHandle

Обработка списка маршрутов, в который нужно добавить маршруты. Укажите значение NULL , чтобы удалить указанные маршруты из старых списков.

[in] NumRoutes

Указывает количество маршрутов в RouteHandles.

[in] RouteHandles

Указатель на массив дескрипторов маршрута для перехода из старого списка в новый.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.

Если функция завершается сбоем, возвращается один из следующих кодов ошибок.

Значение Значение
ERROR_INVALID_HANDLE
Дескриптор недействителен.

Комментарии

Если маршруты больше не требуются, отпустите их, вызвав RtmReleaseRoutes.

Пример кода, использующий эту функцию, см. в разделе Использование списка маршрутов Client-Specific.

Требования

Требование Значение
Минимальная версия клиента Ни одна версия не поддерживается
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header rtmv2.h
Библиотека Rtm.lib
DLL Rtm.dll

См. также раздел

RtmCreateRouteList

RtmDeleteRouteList