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.
A função SetIpForwardEntry2 define as propriedades de uma entrada de rota IP em um computador local.
Sintaxe
NETIOAPI_API SetIpForwardEntry2(
_In_ const MIB_IPFORWARD_ROW2 *Route
);
Parâmetros
-
Rota [in]
Um ponteiro para uma entrada de estrutura MIB_IPFORWARD_ROW2 para uma entrada de rota IP. Seu driver deve definir o DestinationPrefix membro da estrutura MIB_IPFORWARD_ROW2 para um prefixo e família de destino IP válidos, definir o NextHop membro de MIB_IPFORWARD_ROW2 para um endereço IP válido e família e especificar o membro InterfaceLuid ou o InterfaceIndex membro de MIB_IPFORWARD_ROW2.
Valor de retorno
SetIpForwardEntry2 retorna STATUS_SUCCESS se a função for bem-sucedida.
Se a função falhar, SetIpForwardEntry2 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 for passado no parâmetro Route, o DestinationPrefix membro da estrutura de MIB_IPFORWARD_ROW2 para a qual o parâmetro Route aponta não foi especificado, o NextHop membro da estrutura MIB_IPFORWARD_ROW2 não foi especificado, ou ambos InterfaceLuid e InterfaceIndex membros da estrutura MIB_IPFORWARD_ROW2 não foram especificados. |
| STATUS_NOT_FOUND | A interface especificada não pôde ser encontrada. Este erro é retornado se a função não conseguir encontrar a interface de rede especificada pelo InterfaceLuid ou InterfaceIndex membro da estrutura de MIB_IPFORWARD_ROW2 para a qual o parâmetro Route aponta. |
| Outros | Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado. |
Comentários
A função SetIpForwardEntry2 é usada para definir as propriedades de uma entrada de rota IP existente em um computador local.
O driver deve inicializar os seguintes membros da estrutura de MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta.
DestinationPrefix
Defina como um prefixo e uma família de endereços IPv4 ou IPv6 válidos.NextHop
Defina como um endereço e uma família IPv4 ou IPv6 válidos.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.
O deslocamento da métrica de rota especificado na Métrica membro da estrutura de MIB_IPFORWARD_ROW2 que parâmetro Route aponta para representar apenas parte da métrica de rota completa. A métrica completa é uma combinação desse deslocamento da métrica de rota adicionada à métrica de interface especificada na Métrica membro da estrutura MIB_IPINTERFACE_ROW da interface associada. Um driver pode recuperar a métrica da interface chamando a funçãoGetIpInterfaceEntry.
SetIpForwardEntry2 ignora os Age e Origin membros da estrutura de MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta. Esses membros são definidos pela pilha de rede e não podem ser alterados usando a função SetIpForwardEntry2.
A função SetIpForwardEntry2 falhará se o DestinationPrefix e NextHop membros da estrutura de MIB_IPFORWARD_ROW2 que o parâmetro Route aponta para não corresponder a uma entrada de rota IP na interface especificada.