Функция DeleteAnycastIpAddressEntry (netioapi.h)

Статья
08/25/2023

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

Синтаксис

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteAnycastIpAddressEntry(
  [in] const MIB_ANYCASTIPADDRESS_ROW *Row
);

Параметры

[in] Row

Указатель на запись структуры MIB_ANYCASTIPADDRESS_ROW для существующей записи IP-адреса любой рассылки, удаляемой с локального компьютера.

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

Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.

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

Код возврата	Описание
ERROR_ACCESS_DENIED	Отказано в доступе". Эта ошибка возвращается при нескольких условиях, которые включают следующее: у пользователя отсутствуют необходимые права администратора на локальном компьютере или приложение не выполняется в расширенной оболочке в качестве встроенного администратора (администратора запуска от имени).
ERROR_INVALID_PARAMETER	В функцию передан недопустимый параметр. Эта ошибка возвращается, если в параметре Row передается указатель NULL, члену AddressMIB_ANYCASTIPADDRESS_ROW, на который указывает параметр Row, не задан допустимый адрес IPv4 или IPv6 одноадресной рассылки, либо оба элемента InterfaceLuid или InterfaceIndexMIB_ANYCASTIPADDRESS_ROW, на которые указывает параметр Row, были не указаны.
ERROR_NOT_FOUND	Не удалось найти указанный интерфейс. Эта ошибка возвращается, если не удалось найти сетевой интерфейс, заданный элементом InterfaceLuid или InterfaceIndexMIB_ANYCASTIPADDRESS_ROW , на который указывает параметр Row .
ERROR_NOT_SUPPORTED	Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере отсутствует стек IPv4 и в элементе AddressMIB_ANYCASTIPADDRESS_ROW указан IPv4-адрес, на который указывает параметр Row . Эта ошибка также возвращается, если на локальном компьютере отсутствует стек IPv6 и в элементе Address был указан IPv6-адрес .
Другое	Используйте FormatMessage , чтобы получить строку сообщения для возвращенной ошибки.

На входных данных элементу Address в структуре MIB_ANYCASTIPADDRESS_ROW , на которую указывает параметр Row , необходимо задать допустимый одноадресный IPv4- или IPv6-адрес и семейство. Кроме того, необходимо инициализировать по крайней мере один из следующих элементов в структуре MIB_ANYCASTIPADDRESS_ROW , указываемой на параметр Row : InterfaceLuid или InterfaceIndex.

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

Если функция выполнена успешно, существующий IP-адрес, представленный параметром Row , был удален.

Функцию GetAnycastIpAddressTable можно вызвать для перечисления записей IP-адресов любой рассылки на локальном компьютере. Функцию GetAnycastIpAddressEntry можно вызвать, чтобы получить определенную существующую запись ip-адреса anycast.

Функция DeleteAnycastIpAddressEntry может вызываться только пользователем, вошедшего в систему как член группы Администраторы. Если метод DeleteAnycastIpAddressEntry вызывается пользователем, не входящий в группу Администраторы, вызов функции завершится ошибкой и возвращается ERROR_ACCESS_DENIED . Эта функция также может завершиться ошибкой из-за контроля учетных записей (UAC) в Windows Vista и более поздних версиях. Если приложение, содержащее эту функцию, выполняется пользователем, вошедшего в систему как участник группы администраторов, отличный от встроенного администратора, этот вызов завершится ошибкой, если приложение не было отмечено в файле манифеста параметром requestedExecutionLevel , для которого задано значение requireAdministrator. Если в приложении отсутствует этот файл манифеста, пользователь, вошедший в группу администраторов, отличный от встроенного администратора, должен выполнять приложение в расширенной оболочке в качестве встроенного администратора (администратора запуска от имени) для успешного выполнения этой функции.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	netioapi.h (включая Iphlpapi.h)
Библиотека	Iphlpapi.lib
DLL	Iphlpapi.dll