Функция GetAnycastIpAddressEntry

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

Синтаксис

NETIOAPI_API GetAnycastIpAddressEntry(
  _Inout_ PMIB_ANYCASTIPADDRESS_ROW Row
);

Параметры

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

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

GetAnycastIpAddressEntry возвращает STATUS_SUCCESS, если функция выполнена успешно.

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

Возвращаемый код Описание
STATUS_INVALID_PARAMETER

Недопустимый параметр был передан функции. Эта ошибка возвращается, если указатель NULL передается в параметре строки, Элемент адрес структуры MIB_ANYCASTIPADDRESS_ROW, на который указывает параметр Row, не задан допустимый адрес IPv4 или IPv6 или InterfaceLuid и InterfaceIndex элементов структуры MIB_ANYCASTIPADDRESS_ROW.

STATUS_NOT_FOUND

Не удалось найти указанный интерфейс. Эта ошибка возвращается, если функция не может найти сетевой интерфейс, указанный InterfaceLuid или InterfaceIndex член структуры MIB_ANYCASTIPADDRESS_ROW, на которую указывает параметр Row.

STATUS_NOT_SUPPORTED

Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере не находится стек IPv4, а адрес IPv4 указан в элементе Address структуры MIB_UNICASTIPADDRESS_ROW, на которую указывает параметр строка, или если на локальном компьютере не указан стек IPv6, а адрес IPv6 указан в элементе адреса.

Другие

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

Замечания

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

При входе драйвер должен инициализировать следующие члены структуры MIB_ANYCASTIPADDRESS_ROW, на которые указывает параметр строка.

  • адрес
    Задайте допустимый IPv4 или IPv6-адрес и семейство рассылки.

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

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

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

Требования

Целевая платформа

универсальные

Версия

Доступно в Windows Vista и более поздних версиях операционных систем Windows.

Заголовок

Netioapi.h (include Netioapi.h)

Библиотека

Netio.lib

IRQL

< DISPATCH_LEVEL

См. также

CreateAnycastIpAddressEntry

DeleteAnycastIpAddressEntry

GetAnycastIpAddressTable

MIB_ANYCASTIPADDRESS_ROW

MIB_ANYCASTIPADDRESS_TABLE