Функция GetAnycastIpAddressEntry
Функция GetAnycastIpAddressEntry извлекает сведения о существующей записи любого ip-адреса на локальном компьютере.
Синтаксис
NETIOAPI_API GetAnycastIpAddressEntry(
_Inout_ PMIB_ANYCASTIPADDRESS_ROW Row
);
Параметры
- Строка [вход, выход]
Указатель на запись структуры MIB_ANYCASTIPADDRESS_ROW для записи ip-адреса с любой рассылкой. При успешном возвращении эта структура обновляется свойствами для существующего IP-адреса любой рассылки.
Возвращаемое значение
GetAnycastIpAddressEntry возвращает STATUS_SUCCESS, если функция выполнена успешно.
В случае сбоя функции GetAnycastIpAddressEntry возвращает один из следующих кодов ошибок:
| Код возврата | Описание |
|---|---|
| STATUS_INVALID_PARAMETER | В функцию передан недопустимый параметр. Эта ошибка возвращается, если в параметре Row передается указатель NULL, члену AddressMIB_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, на которую указывает параметр Row , или если на локальном компьютере не расположен стек IPv6, а адрес IPv6 был указан в элементе Address . |
| Другое | Используйте функцию FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки. |
Комментарии
Функция GetAnycastIpAddressEntry используется для получения существующей записи структуры MIB_ANYCASTIPADDRESS_ROW .
При входе драйвер должен инициализировать следующие элементы структуры MIB_ANYCASTIPADDRESS_ROW, на которую указывает параметр Row .
Адрес
Задайте допустимый адрес IPv4 или IPv6 anycast и семейство.InterfaceLuid или InterfaceIndex
Эти элементы используются в порядке, указанном ранее. Таким образом, если указан InterfaceLuid , этот член используется для определения интерфейса. Если для элемента InterfaceLuid не задано значение (значение этого элемента равно нулю), для определения интерфейса будет использоваться элемент InterfaceIndex .
При успешном вызове GetAnycastIpAddressEntry извлекает другие свойства для ip-адреса anycast и заполняет структуру MIB_ANYCASTIPADDRESS_ROW, на которую указывает параметр Row .
Драйвер может вызвать функцию GetAnycastIpAddressTable для перечисления записей ip-адресов anycast на локальном компьютере.
Требования
Целевая платформа |
Универсальное |
Версия |
Доступно в Windows Vista и более поздних версиях операционных систем Windows. |
Заголовок |
Netioapi.h (включая Netioapi.h) |
Библиотека |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |