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

Статья
03/15/2023

Функция FlushIpPathTable очищает таблицу IP-путей на локальном компьютере.

Синтаксис

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API FlushIpPathTable(
  [in] ADDRESS_FAMILY Family
);

Параметры

[in] Family

Семейство адресов для очистки.

Возможные значения для семейства адресов перечислены в файле заголовка Winsock2.h . Обратите внимание, что значения для семейства адресов AF_ и констант семейства PF_ протоколов идентичны (например, AF_INET и PF_INET), поэтому можно использовать либо константу.

На Windows SDK, выпущенном для Windows Vista и более поздних версий, организация файлов заголовков изменилась, и возможные значения для этого элемента определяются в файле заголовка Ws2def.h. Обратите внимание, что файл заголовка Ws2def.h автоматически включается в Winsock2.h и никогда не должен использоваться напрямую.

В настоящее время поддерживаются значения AF_INET, AF_INET6 и AF_UNSPEC.

Значение	Значение
AF_UNSPEC 0	Семейство адресов не указано. Если указан этот параметр, эта функция очищает таблицу IP-путей, содержащую записи IPv4 и IPv6.
AF_INET 2	Семейство адресов IPv4. Если указан этот параметр, эта функция очищает таблицу IP-путей, содержащую только записи IPv4.
AF_INET6 23	Семейство адресов IPv6. Если указан этот параметр, эта функция очищает таблицу IP-путей, содержащую только записи IPv6.

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

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

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

Код возврата	Описание
ERROR_ACCESS_DENIED	Отказано в доступе". Эта ошибка возвращается при нескольких условиях, которые включают следующее: у пользователя отсутствуют необходимые права администратора на локальном компьютере или приложение не выполняется в расширенной оболочке в качестве встроенного администратора (администратора запуска от имени).
ERROR_INVALID_PARAMETER	В функцию передан недопустимый параметр. Эта ошибка возвращается, если параметр Family не был указан как AF_INET, AF_INET6 или AF_UNSPEC.
ERROR_NOT_SUPPORTED	Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере нет стека IPv4 и AF_INET был указан в параметре Family . Эта ошибка также возвращается, если на локальном компьютере нет стека IPv6 и AF_INET6 был указан в параметре Family . Эта ошибка также возвращается в версиях Windows, в которых эта функция не поддерживается.
Другое	Используйте FormatMessage , чтобы получить строку сообщения для возвращенной ошибки.

The
Функция FlushIpPathTable сбрасывает или удаляет записи IP-пути в локальной системе. Параметр Family можно использовать для ограничения удаляемой записи IP-пути определенным семейством IP-адресов. Если записи IP-пути для IPv4 и IPv6 должны быть удалены, задайте для параметра Familyзначение AF_UNSPEC.

Параметр Family должен быть инициализирован AF_INET, AF_INET6 или AF_UNSPEC.

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

Требования

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

См. также раздел

Поделиться через