Função DeleteIpForwardEntry2

A função DeleteIpForwardEntry2 exclui uma entrada de rota IP em um computador local.

Sintaxe

NETIOAPI_API DeleteIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Row
);

Parâmetros

Linha [in]
Um ponteiro para uma entrada de estrutura MIB_IPFORWARD_ROW2 para uma entrada de rota IP. No retorno bem-sucedido, esta entrada é excluída.

Valor de retorno

DeleteIpForwardEntry2 retorna STATUS_SUCCESS se a função for bem-sucedida.

Se a função falhar, DeleteIpForwardEntry2 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 Row, o DestinationPrefix membro da estrutura MIB_IPFORWARD_ROW2 para a qual o parâmetro Row 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 puder encontrar a interface de rede especificada pelo InterfaceLuid ou InterfaceIndex membro da estrutura de MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta.
STATUS_NOT_SUPPORTED	A solicitação não é suportada. Este erro é retornado se nenhuma pilha IPv4 estiver localizada no computador local e um endereço IPv4 tiver sido especificado no endereço membro da estrutura MIB_IPFORWARD_ROW2 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 no membro Endereço.
Outros	Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função DeleteIpForwardEntry2 é usada para excluir uma entrada de estrutura MIB_IPFORWARD_ROW2.

Na entrada, 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.

Na saída, quando a chamada é bem-sucedida, DeleteIpForwardEntry2 exclui a entrada de rota IP.

A função DeleteIpForwardEntry2 falhará se o DestinationPrefix e NextHop membros da estrutura de MIB_IPFORWARD_ROW2 que o parâmetro Row aponta para não corresponderem a uma entrada de rota IP existente na interface especificada no InterfaceLuid ou membros InterfaceIndex.

Seu driver pode chamar o função GetIpForwardTable2 para enumerar as entradas de rota IP em um computador local.

Requerimentos

Plataforma de destino	Universal
Versão	Disponível no Windows Vista e versões posteriores dos sistemas operacionais Windows.
Cabeçalho	Netioapi.h (inclui Netioapi.h)
Biblioteca	Netio.lib
IRQL	< DISPATCH_LEVEL