Compartilhar via


Função GetIpPathTable

A função GetIpPathEntry recupera informações para uma entrada de caminho IP em um computador local.

Sintaxe

NETIOAPI_API GetIpPathTable(
  _In_  ADDRESS_FAMILY    Family,
  _Out_ PMIB_IPPATH_TABLE *Table
);

Parâmetros

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

    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), 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 Ws2def.h diretamente.

    Atualmente, 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 retorna 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 retorna 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 retorna a tabela de caminho ip que contém entradas IPv4 e IPv6.

  • Tabela [out]
    Um ponteiro para uma estrutura MIB_IPPATH_TABLE que contém uma tabela de entradas de caminho IP no computador local.

Retornar valor

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

Se a função falhar, GetIpPathEntry 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 um ponteiro NULL for passado no parâmetro Table ou o parâmetro Family não tiver sido especificado como AF_INET, AF_INET6 ou AF_UNSPEC.

STATUS_NOT_ENOUGH_MEMORY

Recursos de memória insuficientes estão disponíveis para concluir a operação.

STATUS_NOT_FOUND

Nenhuma entrada de caminho IP, conforme especificado no parâmetro Family , foi encontrada.

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 GetIpPathTable enumera as entradas de caminho IP em um computador local e retorna essas informações em uma estrutura MIB_IPPATH_TABLE .

GetIpPathTable retorna as entradas de caminho ip em uma estrutura MIB_IPPATH_TABLE no buffer para o qual o parâmetro Table aponta. A estrutura MIB_IPPATH_TABLE contém uma contagem de entradas de caminho IP e uma matriz de estruturas MIB_IPPATH_ROW para cada entrada de caminho IP. Quando essas estruturas retornadas não forem mais necessárias, o driver deverá liberar a memória chamando FreeMibTable.

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

Observe que a estrutura MIB_IPPATH_TABLE retornada para a qual o parâmetro Table aponta pode conter preenchimento para alinhamento entre o membro NumEntries e a primeira entrada de matriz MIB_IPPATH_ROW no membro Table da estrutura MIB_IPPATH_TABLE. O preenchimento para alinhamento também pode estar presente entre as entradas da matriz MIB_IPPATH_ROW. Qualquer acesso a uma entrada de matriz MIB_IPPATH_ROW deve assumir que o preenchimento pode existir.

Requisitos

Plataforma de destino

Universal

Versão

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

parâmetro

Netioapi.h (inclua Netioapi.h)

Biblioteca

Netio.lib

IRQL

< DISPATCH_LEVEL

Confira também

FreeMibTable

FlushIpPathTable

GetIpPathEntry

MIB_IPPATH_ROW

MIB_IPPATH_TABLE