Функция RtmIsRoute

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

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

Синтаксис

BOOL RtmIsRoute(
  _In_  DWORD ProtocolFamily,
  _In_  PVOID Network,
  _Out_ PVOID BestRoute
);

Параметры

ProtocolFamily [in]

Указывает тип структуры данных, на которую указывает параметр Network, например IP_NETWORK, IPX_NETWORK.

Сеть [в]

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

BestRoute [out]

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

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

Возвращаемое значение является одним из следующих кодов.

Значение Описание
TRUE
Существует по крайней мере один маршрут к указанной сети. Лучший маршрут возвращается в структуре, на которую указывает параметр BestRoute .
FALSE
Маршрут к указанной сети отсутствует или операция завершилась сбоем. Вызовите GetLastError , чтобы получить дополнительные сведения:
NO_ERROR
Операция выполнена успешно, но маршрут к указанной сети отсутствует.
ERROR_INVALID_PARAMETER
Значение параметра ProtocolFamily не соответствует ни одному установленному семейству протоколов.
ERROR_NO_SYSTEM_RESOURCES
Недостаточно ресурсов для выполнения операции.

Требования

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

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

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

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

Getlasterror

IP_NETWORK

IPX_NETWORK

Идентификаторы семейства протоколов RTMv1