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

Статья
02/29/2024

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

Синтаксис

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIfEntry2Ex(
  [in]      MIB_IF_ENTRY_LEVEL Level,
  [in, out] PMIB_IF_ROW2       Row
);

Параметры

[in] Level

Уровень извлекаемых сведений об интерфейсе. Этот параметр может быть одним из значений из типа перечисления MIB_IF_ENTRY_LEVEL , определенного в файле заголовка Netioapi.h .

Значение	Значение
MibIfEntryNormal 0	Значения статистики и состояния, возвращаемые в элементах структуры MIB_IF_ROW2 , на которую указывает параметр Row , возвращаются из верхней части стека фильтров.
MibIfEntryNormalWithoutStatistics 2	Значения состояния (без статистики), возвращаемые в членах структуры MIB_IF_ROW2 , на которую указывает параметр Row , возвращаются из верхней части стека фильтров.

[in, out] Row

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

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

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

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

Код возврата	Описание
ERROR_FILE_NOT_FOUND	Системе не удается найти указанный файл. Эта ошибка возвращается, если luID сетевого интерфейса или индекс интерфейса, заданный элементом InterfaceLuid или InterfaceIndexMIB_IF_ROW2 на который указывает параметр Row , не был значением на локальном компьютере.
ERROR_INVALID_PARAMETER	В функцию передан недопустимый параметр. Эта ошибка возвращается, если параметр NULL передается в параметр Row . Эта ошибка также возвращается, если элементы InterfaceLuid и InterfaceIndexMIB_IF_ROW2 , на которые указывает параметр Row , не указаны.
Другое	Используйте функцию FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки.

The
Функция GetIfEntry2Ex извлекает сведения для указанного интерфейса в локальной системе и возвращает эти сведения в указателе на
MIB_IF_ROW2 структура. GetIfEntry2Ex — это расширенная версия функции GetIfEntry2 , которая позволяет выбирать уровень сведений об интерфейсе для извлечения.

При входе необходимо инициализировать по крайней мере один из следующих элементов в структуре MIB_IF_ROW2 , переданной в параметре Row : InterfaceLuid или InterfaceIndex.

Поля используются в указанном выше порядке. Поэтому если указан InterfaceLuid , то этот член используется для определения интерфейса. Если для элемента InterfaceLuid не задано значение (значение этого элемента равно нулю), то для определения интерфейса используется элемент InterfaceIndex .

В выходных данных заполняются остальные поля структуры MIB_IF_ROW2 , на которую указывает параметр Row .

Обратите внимание, что файл заголовка Netioapi.h автоматически включается в файл заголовка Iphlpapi.h и никогда не должен использоваться напрямую.

Требования

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