Função GetIpPathEntry (netioapi.h)
A função GetIpPathEntry recupera informações de uma entrada de caminho IP no computador local.
Sintaxe
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpPathEntry(
[in, out] PMIB_IPPATH_ROW Row
);
Parâmetros
[in, out] Row
Um ponteiro para uma entrada de estrutura MIB_IPPATH_ROW para uma entrada de caminho IP. No retorno bem-sucedido, essa estrutura será atualizada com as propriedades para entrada de caminho 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 |
|---|---|
|
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_IPPATH_ROW apontado pelo parâmetro Row não for um valor no computador local. |
|
Um parâmetro está incorreto. Esse erro será retornado se um ponteiro NULL for passado no parâmetro Row , o membro si_family no membro Destination do MIB_IPPATH_ROW apontado pelo parâmetro Row não estiver definido como AF_INET ou AF_INET6 ou os membros InterfaceLuid ou InterfaceIndex do MIB_IPPATH_ROW apontado pelo parâmetro Row não forem especificados. Esse erro também será retornado se o membro si_family no membro Source do MIB_IPPATH_ROW apontado pelo parâmetro Row não corresponder à família de endereços IP de destino e o si_family do endereço IP de origem não for especificado como AF_UNSPEC. |
|
Elemento não encontrado. Esse erro será retornado se o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex da estrutura MIB_IPPATH_ROW apontada pelo parâmetro Row não corresponder à família de endereços e endereços IP especificada no membro Destination na estrutura MIB_IPPATH_ROW . |
|
A solicitação não terá suporte. Esse erro será retornado se nenhuma pilha IPv4 estiver no computador local e um endereço IPv4 for especificado nos membros de Origem e Destino do MIB_IPPATH_ROW apontado pelo parâmetro Row . Esse erro também será retornado se nenhuma pilha IPv6 estiver no computador local e um endereço IPv6 for especificado nos membros Origem e Destino . |
|
Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado. |
Comentários
A função GetIpPathEntry é definida no Windows Vista e posterior.
A função GetIpPathEntry é usada para recuperar uma entrada de estrutura MIB_IPPATH_ROW .
Na entrada, o membro Destination na estrutura MIB_IPPATH_ROW apontada pelo parâmetro Row deve ser inicializado para um endereço IPv4 ou IPv6 válido e família. A família de endereços especificada em Membro de origem na estrutura MIB_IPPATH_ROW também deve corresponder à família de endereços IP de destino especificada no membro Destination ou a família de endereços no membro De origem deve ser especificada como AF_UNSPEC. Além disso, pelo menos um dos seguintes membros na estrutura MIB_IPPATH_ROW 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 for definido para o membro InterfaceLuid (os valores desse membro serão definidos como zero), o membro InterfaceIndex será usado em seguida para determinar a interface.
Na saída quando a chamada é bem-sucedida, GetIpPathEntry recupera as outras propriedades para a entrada de caminho IP e preenche a estrutura MIB_IPPATH_ROW apontada pelo parâmetro Row .
A função GetIpPathTable pode ser chamada para enumerar as entradas de caminho 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 |