Функция RtmGetEnumRoutes (rtmv2.h)
Функция RtmGetEnumRoutes извлекает следующий набор маршрутов в указанном перечислении.
Синтаксис
DWORD RtmGetEnumRoutes(
[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
На входных данных RouteHandles является указателем на структуру RTM_ROUTE_INFO .
В выходных данных RouteHandles получает массив дескрипторов маршрутов.
Возвращаемое значение
Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.
Если функция завершается сбоем, возвращаемое значение представляет собой один из следующих кодов ошибок.
| Значение | Значение |
|---|---|
|
Значение, на которое указывает NumRoutes , больше максимального числа маршрутов, которые клиент может получить с помощью одного вызова. Проверьте RTM_REGN_PROFILE максимальное количество маршрутов, которые клиент может получить с помощью одного вызова. |
|
Нет дополнительных маршрутов для перечисления. |
|
Недостаточно памяти для выполнения этой операции. |
Комментарии
Если маршруты больше не требуются, отпустите их, вызвав RtmReleaseRoutes.
Пример кода, использующий эту функцию, см. в разделе Перечисление всех маршрутов.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Ни одна версия не поддерживается |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | rtmv2.h |
| Библиотека | Rtm.lib |
| DLL | Rtm.dll |