Функция RtmGetListEnumRoutes (rtmv2.h)
Функция RtmGetListEnumRoutes перечисляет набор маршрутов в указанном списке маршрутов.
Синтаксис
DWORD RtmGetListEnumRoutes(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumRoutes,
[out] PRTM_ROUTE_HANDLE RouteHandles
);
Параметры
[in] RtmRegHandle
Дескриптор клиента, полученного из предыдущего вызова RtmRegisterEntity.
[in] EnumHandle
Дескриптор списка маршрутов для перечисления.
[in, out] NumRoutes
На входных данных NumRoutes является указателем на значение UINT , указывающее максимальное количество маршрутов, которые могут быть получены RouteHandles.
В выходных данных NumRoutes получает фактическое количество маршрутов, полученных RouteHandles.
[out] RouteHandles
На входных данных DestInfo является указателем на массив RTM_DEST_INFO структур.
В выходных данных DestInfo заполняется запрошенными сведениями о назначении.
Возвращаемое значение
Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.
Если функция завершается сбоем, возвращаемое значение представляет собой один из следующих кодов ошибок.
| Значение | Значение |
|---|---|
|
Значение, на которое указывает NumRoutes , больше максимального числа маршрутов, которые клиент может получить с помощью одного вызова. Проверьте RTM_REGN_PROFILE максимальное количество маршрутов, которые клиент может получить с помощью одного вызова. |
Комментарии
Повторно вызывайте эту функцию, чтобы получить все маршруты.
Нет дополнительных маршрутов для перечисления, когда диспетчер таблиц маршрутизации возвращает ноль в NumRoutes.
Пример кода, использующий эту функцию, см. в разделе Использование Client-Specific списка маршрутов.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Ни одна версия не поддерживается |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | rtmv2.h |
| Библиотека | Rtm.lib |
| DLL | Rtm.dll |