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