Função GetIpForwardEntry2 (netioapi.h)

Artigo
02/29/2024

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

Sintaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardEntry2(
  [in, out] PMIB_IPFORWARD_ROW2 Row
);

Parâmetros

[in, out] Row

Um ponteiro para uma entrada de estrutura MIB_IPFORWARD_ROW2 para uma entrada de rota IP. No retorno bem-sucedido, essa estrutura será atualizada com as propriedades da entrada de rota IP.

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 seguintes códigos de erro.

Código de retorno	Descrição
ERROR_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 Row , o membro DestinationPrefix do MIB_IPFORWARD_ROW2 apontado pelo parâmetro Row não tiver sido especificado, o membro NextHop do MIB_IPFORWARD_ROW2 apontado pelo parâmetro Row não foi especificado ou os membros InterfaceLuid ou InterfaceIndex do MIB_IPFORWARD_ROW2 apontados pela Linha O parâmetro não foi especificado.
ERROR_NOT_FOUND	Elemento não encontrado. Esse erro será retornado se o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex da estrutura MIB_IPFORWARD_ROW2 apontada pelo parâmetro Row não corresponder ao prefixo de endereço IP e à família de endereços especificados no membro DestinationPrefix na estrutura MIB_IPFORWARD_ROW2 .
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 na família de endereços no membro DestinationPrefix do MIB_IPFORWARD_ROW2 apontado pelo parâmetro Row . Esse erro também será retornado se nenhuma pilha IPv6 estiver no computador local e AF_INET6 tiver sido especificado para a família de endereços no membro DestinationPrefix .
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

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

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

Na entrada, o membro DestinationPrefix na estrutura MIB_IPFORWARD_ROW2 apontada pelo parâmetro Row deve ser inicializado para um prefixo de endereço IPv4 ou IPv6 válido e família. Na entrada, o membro NextHop na estrutura MIB_IPFORWARD_ROW2 apontada pelo parâmetro Row deve ser inicializado para um endereço IPv4 ou IPv6 válido e família. Além disso, pelo menos um dos seguintes membros na estrutura MIB_IPFORWARD_ROW2 apontado para o parâmetro Row deve ser inicializado: InterfaceLuid ou InterfaceIndex.

Os campos são usados na ordem listada acima. Portanto, se o InterfaceLuid for especificado, esse membro será usado para determinar a interface. Se nenhum valor tiver sido definido para o membro InterfaceLuid (os valores desse membro foram definidos 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 apontada pelo parâmetro Row .

O deslocamento de métrica de rota especificado no membro Métrica da estrutura de MIB_IPFORWARD_ROW2 apontada pelo parâmetro Row 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 aplicativo pode recuperar a métrica de interface chamando a função GetIpInterfaceEntry .

A função GetIpForwardTable2 pode ser chamada para enumerar as entradas de rota IP em um computador local.

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