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

Статья
03/13/2024

Функция GetIpNetEntry2 извлекает сведения для записи соседнего IP-адреса на локальном компьютере.

Синтаксис

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpNetEntry2(
  [in, out] PMIB_IPNET_ROW2 Row
);

Параметры

[in, out] Row

Указатель на запись структуры MIB_IPNET_ROW2 для записи соседнего IP-адреса. При успешном возвращении в эту структуру будут добавлены свойства для соседнего IP-адреса.

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

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

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

Код возврата	Описание
ERROR_FILE_NOT_FOUND	Системе не удается найти указанный файл. Эта ошибка возвращается, если luID сетевого интерфейса или индекс интерфейса, заданный элементом InterfaceLuid или InterfaceIndexMIB_IPNET_ROW2 , на который указывает параметр Row , не был значением на локальном компьютере.
ERROR_INVALID_PARAMETER	В функцию передан недопустимый параметр. Эта ошибка возвращается, если в параметре Row передан указатель NULL, члену AddressMIB_IPNET_ROW2, на который указывает параметр Row, не задан допустимый соседний адрес IPv4 или IPv6, либо оба элемента InterfaceLuid или InterfaceIndexMIB_IPNET_ROW2, на который указывает параметр Row, не были заданы.
ERROR_NOT_FOUND	Элемент не найден. Эта ошибка возвращается, если сетевой интерфейс, указанный элементом InterfaceLuid или InterfaceIndexструктуры MIB_IPNET_ROW2 , на которую указывает параметр Row , не соответствует соседнему IP-адресу и семейству адресов, указанным в элементе Address в структуре MIB_IPNET_ROW2 .
ERROR_NOT_SUPPORTED	Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере нет стека IPv4 и в элементе Addressструктуры MIB_IPNET_ROW2 , на которую указывает параметр Row , указан IPv4-адрес. Эта ошибка также возвращается, если на локальном компьютере нет стека IPv6 и в элементе Addressструктуры MIB_IPNET_ROW2 указан IPv6-адрес.
Другое	Используйте FormatMessage , чтобы получить строку сообщения для возвращенной ошибки.

На входных данных элемент Address в структуре MIB_IPNET_ROW2 , на который указывает параметр Row , должен быть инициализирован допустимым соседним адресом IPv4 или IPv6 и семейством. Кроме того, необходимо инициализировать по крайней мере один из следующих элементов в структуре MIB_IPNET_ROW2 , указываемой на параметр Row : InterfaceLuid или InterfaceIndex.

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

При успешном вызове GetIpNetEntry2 извлекает другие свойства для соседнего IP-адреса и заполняет структуру MIB_IPNET_ROW2 , на которую указывает параметр Row .

Функцию GetIpNetTable2 можно вызвать для перечисления записей соседних IP-адресов на локальном компьютере.

Требования

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