Função GetIpPathEntry
A 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.
Retornar valor
GetIpPathEntry retornará 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. Esse erro será retornado se um ponteiro NULL for passado no parâmetro Row , o membro si_family no membro Destination da estrutura MIB_IPPATH_ROW para a qual o parâmetro Row aponta não foi definido como AF_INET ou AF_INET6, ou os membros InterfaceLuid e InterfaceIndex da estrutura MIB_IPPATH_ROW não foram especificados. Esse erro também será retornado se o membro si_familyno membro de origem da estrutura MIB_IPPATH_ROW não corresponder à família de endereços IP de destino e o si_family do endereço IP de origem não tiver sido especificado como AF_UNSPEC. |
| STATUS_NOT_FOUND | Não foi possível encontrar a interface especificada. Esse erro será retornado se a função não puder localizar o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex da estrutura MIB_IPPATH_ROW 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 um endereço IPv4 tiver sido especificado nos membros de Origem e Destino da estrutura MIB_IPPATH_ROW para a qual o parâmetro Row aponta ou se nenhuma pilha IPv6 estiver localizada no computador local e um endereço IPv6 tiver sido especificado nos membros Origem e Destino . |
| Outros | Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado. |
Comentários
A função GetIpPathEntry é usada para recuperar uma entrada de estrutura MIB_IPPATH_ROW .
Na entrada, o driver deve inicializar os membros a seguir da estrutura MIB_IPPATH_ROW para a qual o parâmetro Row aponta.
Destino
Defina como um endereço IPv4 ou IPv6 válido e uma família.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 Destination 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 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 for bem-sucedida, GetIpPathEntry recuperará as outras propriedades para a entrada do caminho IP e preencherá a estrutura 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.
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 |