Função GetIpForwardTable2
A função GetIpForwardTable2 recupera as entradas de rota IP em um computador local.
Sintaxe
NETIOAPI_API GetIpForwardTable2(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_IPFORWARD_TABLE2 *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 roteamento 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 roteamento 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 roteamento de IP que contém entradas IPv4 e IPv6.
Tabela [out]
Um ponteiro para uma estrutura MIB_IPFORWARD_TABLE2 que contém uma tabela de entradas de rota IP no computador local.
Valor retornado
GetIpForwardTable2 retornará STATUS_SUCCESS se a função for bem-sucedida.
Se a função falhar, GetIpForwardTable2 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 rota 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 GetIpForwardTable2 enumera as entradas de rota IP em um computador local e retorna essas informações em uma estrutura MIB_IPFORWARD_TABLE2 .
As entradas de rota IP são retornadas em uma estrutura MIB_IPFORWARD_TABLE2 no buffer para o qual o parâmetro Table aponta. A estrutura MIB_IPFORWARD_TABLE2 contém uma contagem de entradas de rota IP e uma matriz de estruturas MIB_IPFORWARD_ROW2 para cada entrada de rota 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_IPFORWARD_TABLE2 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_IPFORWARD_ROW2 no membro Table da estrutura MIB_IPFORWARD_TABLE2. O preenchimento para alinhamento também pode estar presente entre as entradas da matriz MIB_IPFORWARD_ROW2. Qualquer acesso a uma entrada de matriz MIB_IPFORWARD_ROW2 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. |
Cabeçalho |
Netioapi.h (inclua Netioapi.h) |
Biblioteca |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |