Функция RtmCreateRouteListEnum (rtmv2.h)
Функция RtmCreateRouteListEnum создает перечисление маршрутов в указанном списке маршрутов.
Синтаксис
DWORD RtmCreateRouteListEnum(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ROUTE_LIST_HANDLE RouteListHandle,
[out] PRTM_ENUM_HANDLE RtmEnumHandle
);
Параметры
[in] RtmRegHandle
Дескриптор клиента, полученного из предыдущего вызова RtmRegisterEntity.
[in] RouteListHandle
Выполните обработку списка маршрутов для перечисления, полученного из предыдущего вызова RtmCreateRouteList.
[out] RtmEnumHandle
На входных данных RtmEnumHandle является указателем на NULL.
В выходных данных RtmEnumHandle получает указатель на дескриптор перечисления . Используйте этот дескриптор во всех последующих вызовах функций, которые перечисляют список маршрутов.
Возвращаемое значение
Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.
Если функция завершается сбоем, возвращаемое значение представляет собой один из следующих кодов ошибок.
| Значение | Значение |
|---|---|
|
Недостаточно памяти для выполнения этой операции. |
Комментарии
Если дескриптор перечисления больше не требуется, отпустите его, вызвав RtmDeleteEnumHandle.
Пример кода, использующий эту функцию, см. в разделе Использование Client-Specific списка маршрутов.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Ни одна версия не поддерживается |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | rtmv2.h |
| Библиотека | Rtm.lib |
| DLL | Rtm.dll |