Função FlushIpNetTable2 (netioapi.h)

Artigo
03/05/2024

A função FlushIpNetTable2 libera a tabela de vizinho ip no computador local.

Sintaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API FlushIpNetTable2(
  [in] ADDRESS_FAMILY Family,
  [in] NET_IFINDEX    InterfaceIndex
);

Parâmetros

[in] Family

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 PF_ constantes da família de protocolos são idênticos (por exemplo, AF_INET e PF_INET), portanto, qualquer constante pode ser usada.

Na SDK do Windows lançada para Windows Vista e posterior, a organização dos arquivos de cabeçalho foi alterada e os valores possíveis para esse membro são definidos no arquivo de cabeçalho Ws2def.h. Observe que o arquivo de cabeçalho Ws2def.h é incluído automaticamente no Winsock2.h e nunca deve ser usado diretamente.

Os valores com suporte no momento são AF_INET, AF_INET6 e AF_UNSPEC.

Valor	Significado
AF_UNSPEC 0	A família de endereços não é especificada. Quando esse parâmetro é especificado, essa função libera a tabela de endereços IP vizinho que contém entradas IPv4 e IPv6.
AF_INET 2	A família de endereços IPv4 (Protocolo de Internet versão 4). Quando esse parâmetro é especificado, essa função libera a tabela de endereços IP vizinho que contém apenas entradas IPv4.
AF_INET6 23	A família de endereços IPv6 (Internet Protocol versão 6). Quando esse parâmetro é especificado, essa função libera a tabela de endereços IP vizinho que contém apenas entradas IPv6.

[in] InterfaceIndex

O índice da interface. Se o índice for especificado, libere as entradas de endereço IP vizinho em uma interface específica, caso contrário, libere as entradas de endereço IP vizinho em todas as interfaces. Para ignorar a interface, defina esse parâmetro como zero.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos códigos de erro a seguir.

Código de retorno	Descrição
ERROR_ACCESS_DENIED	Acesso negado. Esse erro é retornado sob várias condições que incluem o seguinte: o usuário não tem os privilégios administrativos necessários no computador local ou o aplicativo não está em execução em um shell aprimorado como administrador interno (administrador RunAs).
ERROR_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.
ERROR_NOT_SUPPORTED	A solicitação não terá suporte. Esse erro será retornado se nenhuma pilha IPv4 estiver no computador local e AF_INET tiver sido especificado no parâmetro Family . Esse erro também será retornado se nenhuma pilha IPv6 estiver no computador local e AF_INET6 tiver sido especificado 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 FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função FlushIpNetTable2 é definida no Windows Vista e posterior.

O
A função FlushIpNetTable2 libera ou exclui os endereços IP vizinhos em um sistema local. O parâmetro Family pode ser usado 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, defina o parâmetro Family como AF_UNSPEC. O parâmetro InterfaceIndex pode ser usado para limitar os endereços IP vizinhos a serem excluídos para uma interface específica. Se os endereços IP vizinhos de todas as interfaces devem ser excluídos, defina o parâmetro InterfaceIndex como zero.

O parâmetro Family deve ser inicializado para AF_INET, AF_INET6 ou AF_UNSPEC.

A função FlushIpNetTable2 só pode ser chamada por um usuário conectado como membro do grupo Administradores. Se FlushIpNetTable2 for chamado por um usuário que não seja membro do grupo Administradores, a chamada de função falhará e ERROR_ACCESS_DENIED será retornado. Essa função também pode falhar devido ao UAC (controle de conta de usuário) no Windows Vista e posterior. Se um aplicativo que contém essa função for executado por um usuário conectado como um membro do grupo Administradores diferente do Administrador interno, essa chamada falhará, a menos que o aplicativo tenha sido marcado no arquivo de manifesto com um requestedExecutionLevel definido como requireAdministrator. Se o aplicativo não tiver esse arquivo de manifesto, um usuário conectado como membro do grupo Administradores diferente do Administrador interno deverá executar o aplicativo em um shell aprimorado como administrador interno (administrador RunAs) para que essa função tenha êxito.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	netioapi.h (inclua Iphlpapi.h)
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll