Função DeleteIpForwardEntry2

Artigo
03/08/2023

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, essa entrada é excluída.

Retornar valor

DeleteIpForwardEntry2 retornará 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. Esse erro será retornado se um ponteiro NULL for passado no parâmetro Row , o membro DestinationPrefix da estrutura MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta não foi especificado, o membro NextHop da estrutura MIB_IPFORWARD_ROW2 não foi especificado ou os membros InterfaceLuid e InterfaceIndex da estrutura MIB_IPFORWARD_ROW2 não foram especificados.
STATUS_NOT_FOUND	Não foi possível encontrar a interface especificada. Esse erro será retornado se a função não puder encontrar o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex da estrutura MIB_IPFORWARD_ROW2 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 no membro Address 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 Address .
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 MIB_IPFORWARD_ROW2 para a qual o parâmetro Row aponta.

DestinationPrefix
Defina como um prefixo de endereço IPv4 ou IPv6 válido e família.
NextHop
Defina como um endereço IPv4 ou IPv6 válido e uma família.
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 é bem-sucedida, DeleteIpForwardEntry2 exclui a entrada de rota IP.

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

Seu driver pode chamar a função GetIpForwardTable2 para enumerar as entradas de rota 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