Функция if_nametoindex (netioapi.h)

Статья
03/15/2023

Функция if_nametoindex преобразует имя интерфейса ANSI для сетевого интерфейса в локальный индекс интерфейса.

Синтаксис

IPHLPAPI_DLL_LINKAGE NET_IFINDEX NETIOAPI_API_ if_nametoindex(
  [in] PCSTR InterfaceName
);

Параметры

[in] InterfaceName

Указатель на строку ANSI, завершающуюся null, содержащую имя интерфейса.

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

При успешном выполнении if_nametoindex возвращает индекс локального интерфейса. При сбое возвращается ноль.

Функция if_nametoindex сопоставляет имя интерфейса с соответствующим индексом. Эта функция разработана как часть базовых расширений сокетов для IPv6, как описано в IETF в RFC 2553. Для получения дополнительной информации см. http://www.ietf.org/rfc/rfc2553.txt.

Функция if_nametoindex реализована для переносимости приложений в средах Unix, но предпочтительнее использовать функции ConvertInterface. Функцию if_nametoindex можно заменить вызовом функции ConvertInterfaceNameToLuidA для преобразования имени интерфейса ANSI в NET_LUID последующего вызова ConvertInterfaceLuidToIndex для преобразования NET_LUID в индекс локального интерфейса.

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

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	netioapi.h (включая Iphlpapi.h)
Библиотека	Iphlpapi.lib
DLL	Iphlpapi.dll