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