Функция FlushIpPathTable
Функция FlushIpPathTable очищает таблицу IP-путей на локальном компьютере.
Синтаксис
NETIOAPI_API FlushIpPathTable(
_In_ ADDRESS_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 | Недопустимый параметр был передан функции. Эта ошибка возвращается, если параметр семейства не указан как 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.
Драйвер должен инициализировать параметр семейства для AF_INET, AF_INET6 или AF_UNSPEC.