Função DeleteIpForwardEntry2 (netioapi.h)

Artigo
08/25/2023

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

Sintaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteIpForwardEntry2(
  [in] const MIB_IPFORWARD_ROW2 *Row
);

Parâmetros

[in] Row

Um ponteiro para uma entrada de estrutura MIB_IPFORWARD_ROW2 para uma entrada de rota IP. No retorno bem-sucedido, essa entrada será excluída.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Código de retorno	Descrição
ERROR_ACCESS_DENIED	Acesso negado. Esse erro é retornado sob várias condições que incluem o seguinte: o usuário não tem os privilégios administrativos necessários no computador local ou o aplicativo não está em execução em um shell aprimorado como administrador interno (administrador de RunAs).
ERROR_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 do MIB_IPFORWARD_ROW2 apontado pelo parâmetro Row não tiver sido especificado, o membro NextHop do MIB_IPFORWARD_ROW2 apontado pelo parâmetro Row não foi especificado ou os membros InterfaceLuid ou InterfaceIndex do MIB_IPFORWARD_ROW2 apontados pela Linha O parâmetro não foi especificado.
ERROR_NOT_FOUND	Não foi possível encontrar a interface especificada. Esse erro será retornado se o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex do MIB_IPFORWARD_ROW2 apontado pelo parâmetro Row não puder ser encontrado.
ERROR_NOT_SUPPORTED	A solicitação não terá suporte. Esse erro será retornado se nenhuma pilha IPv4 estiver no computador local e um endereço IPv4 tiver sido especificado no membro Address do MIB_IPFORWARD_ROW2 apontado pelo parâmetro Row . Esse erro também será retornado se nenhuma pilha IPv6 estiver no computador local e um endereço IPv6 tiver sido especificado no membro Address .
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função DeleteIpForwardEntry2 é definida no Windows Vista e posterior.

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

Na entrada, o membro DestinationPrefix na estrutura MIB_IPFORWARD_ROW2 apontada pelo parâmetro Row deve ser inicializado para um prefixo de endereço IPv4 ou IPv6 válido e família. Na entrada, o membro NextHop na estrutura MIB_IPFORWARD_ROW2 apontada pelo parâmetro Row deve ser inicializado para um endereço IPv4 ou IPv6 válido e família. Além disso, pelo menos um dos seguintes membros na estrutura MIB_IPFORWARD_ROW2 apontado para o parâmetro Row deve ser inicializado: InterfaceLuid ou InterfaceIndex.

Os campos são usados na ordem listada acima. Portanto, se o InterfaceLuid for especificado, esse membro será usado para determinar a interface. Se nenhum valor tiver sido definido para o membro InterfaceLuid (os valores desse membro foram definidos 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 do MIB_IPFORWARD_ROW2 apontados pelo parâmetro Row não corresponderem a uma entrada de rota IP existente na interface especificada nos membros InterfaceLuid ou InterfaceIndex .

A função GetIpForwardTable2 pode ser chamada para enumerar as entradas de rota IP em um computador local.

A função DeleteIpForwardEntry2 só pode ser chamada por um usuário conectado como membro do grupo Administradores. Se DeleteIpForwardEntry2 for chamado por um usuário que não é membro do grupo Administradores, a chamada de função falhará e ERROR_ACCESS_DENIED será retornado. Essa função também pode falhar devido ao UAC (controle de conta de usuário) no Windows Vista e posterior. Se um aplicativo que contém essa função for executado por um usuário conectado como membro do grupo Administradores diferente do Administrador interno, essa chamada falhará, a menos que o aplicativo tenha sido marcado no arquivo de manifesto com um requestedExecutionLevel definido para exigirAdministrator. Se o aplicativo não tiver esse arquivo de manifesto, um usuário conectado como membro do grupo Administradores diferente do Administrador interno deverá executar o aplicativo em um shell aprimorado como administrador interno (administrador RunAs) para que essa função tenha êxito.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	netioapi.h (inclua Iphlpapi.h)
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll