Função GetIpNetEntry2 (netioapi.h)

Artigo
02/29/2024

A função GetIpNetEntry2 recupera informações para uma entrada de endereço IP vizinho no computador local.

Sintaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpNetEntry2(
  [in, out] PMIB_IPNET_ROW2 Row
);

Parâmetros

[in, out] Row

Um ponteiro para uma entrada de estrutura MIB_IPNET_ROW2 para uma entrada de endereço IP vizinho. No retorno bem-sucedido, essa estrutura será atualizada com as propriedades do endereço IP vizinho.

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_FILE_NOT_FOUND	O sistema não pode encontrar o arquivo especificado. Esse erro será retornado se o LUID da interface de rede ou o índice de interface especificado pelo membro InterfaceLuid ou InterfaceIndex do MIB_IPNET_ROW2 apontado pelo parâmetro Row não for um valor no computador local.
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 Address do MIB_IPNET_ROW2 apontado pelo parâmetro Row não tiver sido definido como um endereço IPv4 ou IPv6 vizinho válido ou os membros InterfaceLuid ou InterfaceIndex do MIB_IPNET_ROW2 apontados pelo parâmetro Row não foram especificados.
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_IPNET_ROW2 apontada pelo parâmetro Row não corresponder ao endereço IP vizinho e à família de endereços especificados no membro Address na estrutura MIB_IPNET_ROW2 .
ERROR_NOT_SUPPORTED	A solicitação não terá suporte. Esse erro será retornado se nenhuma pilha IPv4 estiver no computador local e um endereço IPv4 tiver sido especificado no membro Address da estrutura MIB_IPNET_ROW2 apontada pelo parâmetro Row . Esse erro também será retornado se nenhuma pilha IPv6 estiver no computador local e um endereço IPv6 tiver sido especificado no membro Address da estrutura MIB_IPNET_ROW2 .
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

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

A função GetIpNetEntry2 é usada para recuperar uma entrada de estrutura MIB_IPNET_ROW2 .

Na entrada, o membro Address na estrutura de MIB_IPNET_ROW2 apontado pelo parâmetro Row deve ser inicializado para um endereço IPv4 ou IPv6 e uma família de vizinhos válidos. Além disso, pelo menos um dos seguintes membros na estrutura MIB_IPNET_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 for bem-sucedida, GetIpNetEntry2 recuperará as outras propriedades para o endereço IP vizinho e preencherá a estrutura de MIB_IPNET_ROW2 apontada pelo parâmetro Row .

A função GetIpNetTable2 pode ser chamada para enumerar as entradas de endereço IP vizinhas 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