Функция FlushIpPathTable
Функция FlushIpPathTable очищает таблицу IP-путей на локальном компьютере.
Синтаксис
NETIOAPI_API FlushIpPathTable(
_In_ ADDRESS_FAMILY Family
);
Параметры
Family [in]
Семейство адресов для очистки.Возможные значения для семейства адресов перечислены в файле заголовка Winsock2.h. Обратите внимание, что значения для семейства адресов AF_ и констант семейства PF_ протоколов идентичны (например, AF_INET и PF_INET), поэтому можно использовать обе константы.
В Windows Vista и более поздних версиях операционных систем Windows возможные значения параметра Family определяются в файле заголовка Ws2def.h. Обратите внимание, что файл заголовка Ws2def.h автоматически включается в Netioapi.h, и никогда не следует использовать Ws2def.h напрямую.
В настоящее время для семейства адресов поддерживаются следующие значения:
AF_INET
Семейство адресов IPv4. При указании этого значения эта функция очищает таблицу IP-путей, содержащую только записи IPv4.AF_INET6
Семейство адресов IPv6. Если это значение указано, эта функция очищает таблицу IP-путей, содержащую только записи IPv6.AF_UNSPEC
Семейство адресов не указано. Если указано это значение, эта функция очищает соседнюю таблицу IP-адресов, содержащую записи IPv4 и IPv6.
Возвращаемое значение
Функция FlushIpPathTable возвращает STATUS_SUCCESS, если функция выполнена успешно.
Если функция завершается сбоем, FlushIpPathTable возвращает один из следующих кодов ошибок:
| Код возврата | Описание |
|---|---|
| STATUS_INVALID_PARAMETER | В функцию передан недопустимый параметр. Эта ошибка возвращается, если параметр Family не был указан как AF_INET, AF_INET6 или AF_UNSPEC. |
| STATUS_NOT_SUPPORTED | Запрос не поддерживается. Эта ошибка возвращается, если на локальном компьютере не расположен стек IPv4 и AF_INET был указан в параметре Family , или если на локальном компьютере не расположен стек IPv6 и AF_INET6 был указан в параметре Family . Эта ошибка также возвращается в версиях Windows, в которых эта функция не поддерживается. |
| Другое | Используйте функцию FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки. |
Комментарии
Функция FlushIpPathTable очищает или удаляет записи IP-пути на локальном компьютере. Драйвер может использовать параметр Family , чтобы ограничить удаляемую запись IP-пути определенным семейством IP-адресов. Если записи IP-пути для IPv4 и IPv6 должны быть удалены, драйвер должен задать для параметра Family значение AF_UNSPEC.
Драйвер должен инициализировать параметр Family для AF_INET, AF_INET6 или AF_UNSPEC.
Требования
Целевая платформа |
Универсальное |
Версия |
Доступно в Windows Vista и более поздних версиях операционных систем Windows. |
Заголовок |
Netioapi.h (включая Netioapi.h) |
Библиотека |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |