Partilhar via


Função FlushIpPathTable

A função FlushIpPathTable libera a tabela de caminhos IP em um computador local.

Sintaxe

NETIOAPI_API FlushIpPathTable(
  _In_ ADDRESS_FAMILY Family
);

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 estã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 PF_ protocolo são idênticos (por exemplo, AF_INET e PF_INET), portanto, você pode usar qualquer constante.

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

    Os seguintes valores são atualmente suportados 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 caminho IP 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 caminho IP 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.

Valor de retorno

FlushIpPathTable retorna STATUS_SUCCESS se a função for bem-sucedida.

Se a função falhar, FlushIpPathTable 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. Este erro será retornado se o parâmetro Família não tiver sido especificado como AF_INET, AF_INET6 ou AF_UNSPEC.

STATUS_NOT_SUPPORTED

A solicitação não é suportada. Este erro é retornado se nenhuma pilha IPv4 estiver localizada no computador local e AF_INET foi especificada no parâmetro Família ou se nenhuma pilha IPv6 estiver localizada no computador local e AF_INET6 foi especificada no parâmetro Família. Este erro também é retornado em versões do Windows onde esta função não é suportada.

Outros

Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função FlushIpPathTable libera ou exclui as entradas de caminho IP em um computador local. Seu driver pode usar o parâmetro Family para limitar as entradas de caminho IP a serem excluídas para uma família de endereços IP específica. Se as entradas de caminho IP para IPv4 e IPv6 devem ser excluídas, o driver deve definir o parâmetro Família como AF_UNSPEC.

O driver deve inicializar o parâmetro Família para AF_INET, AF_INET6 ou AF_UNSPEC.

Requerimentos

Plataforma de destino

Universal

Versão

Disponível no Windows Vista e versões posteriores dos sistemas operacionais Windows.

Cabeçalho

Netioapi.h (inclui Netioapi.h)

Biblioteca

Netio.lib

IRQL

< DISPATCH_LEVEL

Ver também

GetIpPathEntry

GetIpPathTable

MIB_IPPATH_ROW

MIB_IPPATH_TABLE