Функция RtmCreateEnumerationHandle

[Этот API был заменен API диспетчера таблиц маршрутизации версии 2 и не будет доступен за пределами Windows Server 2003. Приложения должны использовать API диспетчера таблиц маршрутизации версии 2.]

Функция RtmCreateEnumerationHandle возвращает дескриптор для использования с RtmEnumerateGetNextRoute для сканирования всех маршрутов или подмножества маршрутов, известных диспетчеру таблиц маршрутизации.

Синтаксис

HANDLE RtmCreateEnumerationHandle(
  _In_ DWORD ProtocolFamily,
  _In_ DWORD EnumerationFlags,
  _In_ PVOID CriteriaRoute
);

Параметры

ProtocolFamily [in]

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

EnumerationFlags [in]

Указывает, какие маршруты следует перечислить. Этот параметр ограничивает набор маршрутов, возвращаемых API перечисления, подмножеством, определенным следующими флагами, и значениями в соответствующих элементах структуры, на которые указывает параметр CriteriaRoute . Этот параметр может принимать одно из указанных ниже значений.

EnumerationFlags	Значение
RTM_ONLY_THIS_NETWORK	Перечислять только те маршруты, которые имеют тот же номер сети, что и RR_Network член структуры, на который указывает CriteriaRoute.
RTM_ONLY_THIS_INTERFACE	Перечислять только те маршруты, которые были получены через интерфейс, заданный в поле RR_InterfaceID структуры, на которую указывает CriteriaRoute.
RTM_ONLY_THIS_PROTOCOL	Перечислять только те маршруты, которые были добавлены протоколом маршрутизации, указанным в поле RR_RoutingProtocol структуры, на которую указывает CriteriaRoute.
RTM_ONLY_BEST_ROUTES	Перечислите только лучшие маршруты к каждой из сетей в наборе.

CriteriaRoute [in]

Указатель на структуру маршрута для конкретного семейства протоколов (RTM_IP_ROUTE или RTM_IPX_ROUTE). Значения элементов в этой структуре соответствуют флагам, заданным параметром EnumerationFlags .

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

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

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

Значение	Описание
ERROR_NO_ROUTES	Нет маршрутов с указанными критериями.
ERROR_INVALID_PARAMETER	Один или несколько входных параметров являются недопустимыми (например, неизвестное семейство протоколов, недопустимые флаги перечисления).
ERROR_NO_SYSTEM_RESOURCES	Недостаточно ресурсов для выполнения операции.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно памяти для выделения дескриптора.

Требования

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

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

Справочник по диспетчеру таблиц маршрутизации версии 1

Функции диспетчера таблиц маршрутизации версии 1

Getlasterror

RTM_IP_ROUTE

RTM_IPX_ROUTE

RtmCloseEnumerationHandle

RtmEnumerateGetNextRoute