Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
O função GetIpPathEntry recupera informações para uma entrada de caminho IP em um computador local.
Sintaxe
NETIOAPI_API GetIpPathEntry(
_Inout_ PMIB_IPPATH_ROW Row
);
Parâmetros
-
Linha [entrada, saída]
Um ponteiro para uma entrada de estrutura MIB_IPPATH_ROW para uma entrada de caminho IP. No retorno bem-sucedido, essa estrutura é atualizada com as propriedades para entrada de caminho IP.
Valor de retorno
GetIpPathEntry retorna STATUS_SUCCESS se a função for bem-sucedida.
Se a função falhar, GetIpPathEntry 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. Este erro é retornado se um ponteiro de NULL é passado no parâmetro Row, o membro si_family no Destination membro da estrutura de MIB_IPPATH_ROW para a qual o parâmetro Row aponta não foi definido como AF_INET ou AF_INET6, ou ambos InterfaceLuid e InterfaceIndex membros da estrutura MIB_IPPATH_ROW não foram especificados. Este erro também é retornado se o membro si_family no de origem membro da estrutura MIB_IPPATH_ROW não corresponder à família de endereços IP de destino e o si_family para o endereço IP de origem não foi especificado como AF_UNSPEC. |
| STATUS_NOT_FOUND | A interface especificada não pôde ser encontrada. Este erro é retornado se a função não puder encontrar a interface de rede especificada pelo InterfaceLuid ou InterfaceIndex membro da estrutura de MIB_IPPATH_ROW para a qual o parâmetro Row aponta. |
| STATUS_NOT_SUPPORTED | A solicitação não é suportada. Este erro será retornado se nenhuma pilha IPv4 estiver localizada no computador local e um endereço IPv4 tiver sido especificado nos de Origem e de Destino membros da estrutura de MIB_IPPATH_ROW para a qual o parâmetro Linha aponta, ou se nenhuma pilha IPv6 estiver localizada no computador local e um endereço IPv6 tiver sido especificado nos membros de Origem e de Destino. |
| Outros | Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado. |
Comentários
O função GetIpPathEntry é usado para recuperar uma entrada de estrutura MIB_IPPATH_ROW.
Na entrada, o driver deve inicializar os seguintes membros da estrutura de MIB_IPPATH_ROW para a qual o parâmetro Row aponta.
Destino
Defina como um endereço e uma família IPv4 ou IPv6 válidos.de origem
Defina a família de endereços especificada no membro de origem para a família de endereços IP de destino especificada no membro de destino ou para AF_UNSPEC.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 foi 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, GetIpPathEntry recupera as outras propriedades para a entrada de caminho IP e preenche a estrutura de MIB_IPPATH_ROW para a qual o parâmetro Row aponta.
Seu driver pode chamar a função GetIpPathTable para enumerar as entradas de caminho IP em um computador local.