Função GetIpForwardEntry2

Artigo
03/08/2023

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

Sintaxe

NETIOAPI_API GetIpForwardEntry2(
  _Inout_ PMIB_IPFORWARD_ROW2 Row
);

Parâmetros

Linha [entrada, saída]
Um ponteiro para uma entrada de estrutura MIB_IPFORWARD_ROW2 para uma entrada de rota IP. No retorno bem-sucedido, essa estrutura é atualizada com as propriedades da entrada de rota IP.

Retornar valor

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

Se a função falhar, GetIpForwardEntry2 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 ocorrer uma das seguintes situações: Um ponteiro NULL é passado no parâmetro Row . O membro DestinationPrefix da estrutura MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta não foi especificado. O membro NextHop da estrutura MIB_IPFORWARD_ROW2 não foi especificado. Os membros InterfaceLuid e InterfaceIndex da estrutura MIB_IPFORWARD_ROW2 não foram especificados. O membro PreferredLifetime da estrutura MIB_IPFORWARD_ROW2 é maior que o membro ValidLifetime . O membro SitePrefixLength da estrutura MIB_IPFORWARD_ROW2 é maior que o comprimento do prefixo especificado pelo membro DestinationPrefix .
STATUS_NOT_FOUND	Não foi possível encontrar a interface especificada. Esse erro será retornado se a função não puder encontrar o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex da estrutura MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta.
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 na família de endereços no membro DestinationPrefix da estrutura MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta ou se nenhuma pilha IPv6 estiver localizada no computador local e AF_INET6 tiver sido especificada para a família de endereços no membro DestinationPrefix .
Outros	Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função GetIpForwardEntry2 é usada para recuperar uma entrada de estrutura MIB_IPFORWARD_ROW2 .

Na entrada, o driver deve inicializar os seguintes membros da estrutura MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta.

DestinationPrefix
Defina como um prefixo de endereço IPv4 ou IPv6 válido e família.
NextHop
Defina como um endereço IPv4 ou IPv6 válido e uma família.
InterfaceLuid ou InterfaceIndex
Esses membros são usados na ordem listada anteriormente. Portanto, se InterfaceLuid for especificado, esse membro será usado para determinar a interface. Se nenhum valor tiver sido definido para o membro InterfaceLuid (o valor desse membro foi definido como zero), o membro InterfaceIndex será usado em seguida para determinar a interface.

Na saída, quando a chamada é bem-sucedida, GetIpForwardEntry2 recupera as outras propriedades para a entrada de rota IP e preenche a estrutura MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta.

O deslocamento de métrica de rota especificado no membro Métrica da estrutura MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta representa apenas parte da métrica de rota completa. A métrica completa é uma combinação dessa métrica de rota adicionada à métrica de interface especificada no membro Métrica da estrutura MIB_IPINTERFACE_ROW da interface associada. Um driver pode recuperar a métrica de interface chamando a função GetIpInterfaceEntry .

Seu driver pode chamar a função GetIpForwardTable2 para enumerar as entradas de rota IP em um computador local.

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