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