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

Статья
03/09/2024

Функция GetAnycastIpAddressEntry извлекает сведения о существующей записи IP-адреса любой рассылки на локальном компьютере.

Синтаксис

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetAnycastIpAddressEntry(
  [in, out] PMIB_ANYCASTIPADDRESS_ROW Row
);

Параметры

[in, out] Row

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

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

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

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

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

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

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

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

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

Требования

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