Функция RtmGetFirstRoute

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

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

Синтаксис

DWORD RtmGetFirstRoute(
  _In_    DWORD ProtocolFamily,
  _In_    DWORD EnumerationFlags,
  _Inout_ PVOID Route
);

Параметры

ProtocolFamily [in]

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

EnumerationFlags [in]

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

Маршрут [вход, выход]

Во входных данных route указывает на структуру семейства протоколов ( RTM_IP_ROUTE или RTM_IPX_ROUTE).

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

Выходные данные Route указывает на первый маршрут, соответствующий заданным условиям.

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

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

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

Значение	Описание
ERROR_INVALID_PARAMETER	Один из параметров является недопустимым.
ERROR_NO_ROUTES	Нет маршрутов, соответствующих указанным критериям.
ERROR_NO_SYSTEM_RESOURCES	Недостаточно ресурсов для выполнения операции.

Комментарии

Маршруты возвращаются в следующем порядке:

1. Номер сети
2. Протокол маршрутизации
3. Идентификатор интерфейса
4. Адрес следующего прыжка

Эта функция менее эффективна, чем соответствующая функция дескриптора перечисления RtmEnumerateGetNextRoute.

Требования

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

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

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

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

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetNextRoute