Функция GetMulticastIpAddressEntry

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

Синтаксис

NETIOAPI_API GetMulticastIpAddressEntry(
  _Inout_ PMIB_MULTICASTIPADDRESS_ROW Row
);

Параметры

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

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

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

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

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

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

STATUS_NOT_FOUND

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

STATUS_NOT_SUPPORTED

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

Другие

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

Замечания

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

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

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

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

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

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

Требования

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

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

Версия

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

Заголовок

Netioapi.h (include Netioapi.h)

Библиотека

Netio.lib

IRQL

< DISPATCH_LEVEL

См. также

GetMulticastIpAddressTable

MIB_MULTICASTIPADDRESS_ROW

MIB_MULTICASTIPADDRESS_TABLE