Função FlushIpNetTable2

Artigo
06/15/2023

A função FlushIpNetTable2 libera a tabela vizinha de IP em um computador local.

Sintaxe

NETIOAPI_API FlushIpNetTable2(
  _In_ ADDRESS_FAMILY Family,
  _In_ NET_IFINDEX    InterfaceIndex
);

Parâmetros

Família [in]
A família de endereços a ser liberada.

Os valores possíveis para a família de endereços são listados no arquivo de cabeçalho Winsock2.h. Observe que os valores para a família de endereços AF_ e as constantes da família de protocolos PF_ são idênticos (por exemplo, AF_INET e PF_INET), para que você possa usar qualquer constante.

No Windows Vista e versões posteriores dos sistemas operacionais Windows, os valores possíveis para o parâmetro Family são definidos no arquivo de cabeçalho Ws2def.h. Observe que o arquivo de cabeçalho Ws2def.h é incluído automaticamente em Netioapi.h e você nunca deve usar o Ws2def.h diretamente.

No momento, há suporte para os seguintes valores para a família de endereços:
- AF_INET
  A família de endereços IPv4. Quando esse valor é especificado, essa função libera a tabela de endereços IP vizinha que contém apenas entradas IPv4.
- AF_INET6
  A família de endereços IPv6. Quando esse valor é especificado, essa função libera a tabela de endereços IP vizinha que contém apenas entradas IPv6.
- AF_UNSPEC
  A família de endereços não é especificada. Quando esse valor é especificado, essa função libera a tabela de endereços IP vizinha que contém entradas IPv4 e IPv6.
InterfaceIndex [in]
O índice de interface. Se o índice for especificado, a função liberará as entradas de endereço IP vizinhas em uma interface específica. Além disso, a função libera as entradas de endereço IP vizinhas em todas as interfaces. Para ignorar a interface, defina esse parâmetro como zero.

Retornar valor

FlushIpNetTable2 retornará STATUS_SUCCESS se a função for bem-sucedida.

Se a função falhar, FlushIpNetTable2 retornará um dos seguintes códigos de erro:

Código de retorno	Descrição
STATUS_INVALID_PARAMETER	Um parâmetro inválido foi passado para a função. Esse erro será retornado se o parâmetro Family não tiver sido especificado como AF_INET, AF_INET6 ou AF_UNSPEC.
STATUS_NOT_SUPPORTED	A solicitação não terá suporte. Esse erro será retornado se nenhuma pilha IPv4 estiver localizada no computador local e AF_INET tiver sido especificado no parâmetro Family ou se nenhuma pilha IPv6 estiver localizada no computador local e AF_INET6 tiver sido especificada no parâmetro Family . Esse erro também é retornado em versões do Windows em que essa função não tem suporte.
Outros	Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função FlushIpNetTable2 libera ou exclui os endereços IP vizinhos em um computador local. Seu driver pode usar o parâmetro Family para limitar endereços IP vizinhos a serem excluídos para uma família de endereços IP específica. Se os endereços IP vizinhos para IPv4 e IPv6 devem ser excluídos, o driver deverá definir o parâmetro Family como AF_UNSPEC. Seu driver pode usar o parâmetro InterfaceIndex para limitar endereços IP vizinhos a serem excluídos para uma interface específica. Se os endereços IP vizinhos de todas as interfaces precisarem ser excluídos, o driver deverá definir o parâmetro InterfaceIndex como zero.

O driver deve inicializar o parâmetro Family para AF_INET, AF_INET6 ou AF_UNSPEC.

Requisitos

Plataforma de destino	Universal
Versão	Disponível no Windows Vista e versões posteriores dos sistemas operacionais Windows.
Cabeçalho	Netioapi.h (inclua Netioapi.h)
Biblioteca	Netio.lib
IRQL	< DISPATCH_LEVEL