Функция GetUnicastIpAddressEntry
Функция GetUnicastIpAddressEntry извлекает сведения для существующей записи IP-адреса одноадресной рассылки на локальном компьютере.
Синтаксис
NETIOAPI_API GetUnicastIpAddressEntry(
_Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);
Параметры
-
строк [in, out]
Указатель на запись структуры MIB_UNICASTIPADDRESS_ROW для записи одноадресного IP-адреса. При успешном возвращении эта структура обновляется со свойствами существующего IP-адреса одноадресной рассылки.
Возвращаемое значение
GetUnicastIpAddressEntry возвращает STATUS_SUCCESS, если функция выполнена успешно.
Если функция завершается ошибкой, GetUnicastIpAddressEntry возвращает один из следующих кодов ошибок:
| Возвращаемый код | Описание |
|---|---|
| STATUS_INVALID_PARAMETER | Недопустимый параметр был передан функции. Эта ошибка возвращается, если указатель NULL передается в параметре строки. Элемент адреса структуры MIB_UNICASTIPADDRESS_ROW, на который указывает параметр Row, не задан допустимый одноадресный IPv4 или IPv6-адрес или как InterfaceLuid, так и InterfaceIndex члены структуры MIB_UNICASTIPADDRESS_ROW были не указаны. |
| STATUS_NOT_FOUND | Не удалось найти указанный интерфейс. Эта ошибка возвращается, если функция не может найти сетевой интерфейс, указанный InterfaceLuid или InterfaceIndex член структуры MIB_UNICASTIPADDRESS_ROW, на которую указывает параметр Row. |
| STATUS_NOT_SUPPORTED | Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере не расположен стек IPv4, а адрес IPv4 был указан в элементе адреса структуры MIB_UNICASTIPADDRESS_ROW, на которую указывает параметр строка, или если на локальном компьютере не указан стек IPv6, а адрес IPv6 указан в элементе адрес. |
| Другие | Используйте функцию FormatMessage, чтобы получить строку сообщения для возвращаемой ошибки. |
Замечания
Функция GetUnicastIpAddressEntry обычно используется для получения существующей записи структуры MIB_UNICASTIPADDRESS_ROW для изменения. Затем драйвер может изменить элементы в записи MIB_UNICASTIPADDRESS_ROW, которую он хочет изменить, а затем вызвать функцию SetUnicastIpAddressEntry.
При входе драйвер должен инициализировать следующие члены структуры MIB_UNICASTIPADDRESS_ROW, на которые указывает параметр строка.
адрес
Задайте допустимый ip-адрес и семейство одноадресной рассылки IPv4 или IPv6.InterfaceLuid или InterfaceIn dex
Эти члены используются в порядке, указанном ранее. Поэтому если указан InterfaceLuid, этот элемент используется для определения интерфейса. Если для элемента InterfaceLuid не задано значение (значение этого элемента было равно нулю), элемент InterfaceIndex используется для определения интерфейса.
При успешном вызове GetUnicastIpAddressEntry извлекает другие свойства для IP-адреса одноадресной рассылки и заполняет структуру MIB_UNICASTIPADDRESS_ROW, на которую указывает параметр Row.
Драйвер может вызвать функцию GetUnicastIpAddressTable для перечисления записей IP-адресов одноадресной рассылки на локальном компьютере.