DeleteIpForwardEntry2, fonction (netioapi.h)

Article
03/04/2024

La fonction DeleteIpForwardEntry2 supprime une entrée d’itinéraire IP sur l’ordinateur local.

Syntaxe

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

Paramètres

[in] Row

Pointeur vers une entrée de structure MIB_IPFORWARD_ROW2 pour une entrée de route IP. En cas de retour réussi, cette entrée est supprimée.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Code de retour	Description
ERROR_ACCESS_DENIED	L’accès est refusé. Cette erreur est retournée dans plusieurs conditions, notamment : l’utilisateur n’a pas les privilèges d’administration requis sur l’ordinateur local ou l’application ne s’exécute pas dans un interpréteur de commandes amélioré en tant qu’administrateur intégré (administrateur RunAs).
ERROR_INVALID_PARAMETER	Un paramètre non valide a été transmis à la fonction. Cette erreur est retournée si un pointeur NULL est transmis dans le paramètre Row , si le membre DestinationPrefix du MIB_IPFORWARD_ROW2 pointé par le paramètre Row n’a pas été spécifié, si le membre NextHop du MIB_IPFORWARD_ROW2 pointé par le paramètre Row n’a pas été spécifié, ou si les deux membres InterfaceLuid ou InterfaceIndex du MIB_IPFORWARD_ROW2 pointés par la ligne paramètre n’ont pas été spécifiés.
ERROR_NOT_FOUND	L’interface spécifiée est introuvable. Cette erreur est retournée si l’interface réseau spécifiée par le membre InterfaceLuid ou InterfaceIndex du MIB_IPFORWARD_ROW2 pointé par le paramètre Row est introuvable.
ERROR_NOT_SUPPORTED	La demande n'est pas prise en charge. Cette erreur est retournée si aucune pile IPv4 ne se trouve sur l’ordinateur local et qu’une adresse IPv4 a été spécifiée dans le membre Address du MIB_IPFORWARD_ROW2 pointé vers le paramètre Row . Cette erreur est également retournée si aucune pile IPv6 ne se trouve sur l’ordinateur local et qu’une adresse IPv6 a été spécifiée dans le membre Address .
Autres	Utilisez FormatMessage pour obtenir la chaîne de message pour l’erreur retournée.

Remarques

La fonction DeleteIpForwardEntry2 est définie sur Windows Vista et versions ultérieures.

La fonction DeleteIpForwardEntry2 est utilisée pour supprimer une entrée de structure MIB_IPFORWARD_ROW2 .

Lors de l’entrée, le membre DestinationPrefix dans la structure MIB_IPFORWARD_ROW2 pointée vers le paramètre Row doit être initialisé vers un préfixe d’adresse IPv4 ou IPv6 valide et une famille. Lors de l’entrée, le membre NextHop de la structure MIB_IPFORWARD_ROW2 pointée vers le paramètre Row doit être initialisé vers une adresse et une famille IPv4 ou IPv6 valides. En outre, au moins l’un des membres suivants de la structure MIB_IPFORWARD_ROW2 pointée vers le paramètre Row doit être initialisé : InterfaceLuid ou InterfaceIndex.

Les champs sont utilisés dans l’ordre indiqué ci-dessus. Par conséquent, si l’interfaceLuid est spécifiée, ce membre est utilisé pour déterminer l’interface. Si aucune valeur n’a été définie pour le membre InterfaceLuid (les valeurs de ce membre ont été définies sur zéro), le membre InterfaceIndex est ensuite utilisé pour déterminer l’interface.

Lors de la sortie lorsque l’appel réussit, DeleteIpForwardEntry2 supprime l’entrée de route IP.

La fonction DeleteIpForwardEntry2 échoue si les membres DestinationPrefix et NextHop du MIB_IPFORWARD_ROW2 pointés par le paramètre Row ne correspondent pas à une entrée de route IP existante sur l’interface spécifiée dans les membres InterfaceLuid ou InterfaceIndex .

La fonction GetIpForwardTable2 peut être appelée pour énumérer les entrées d’itinéraire IP sur un ordinateur local.

La fonction DeleteIpForwardEntry2 ne peut être appelée que par un utilisateur connecté en tant que membre du groupe Administrateurs. Si DeleteIpForwardEntry2 est appelé par un utilisateur qui n’est pas membre du groupe Administrateurs, l’appel de fonction échoue et ERROR_ACCESS_DENIED est retourné. Cette fonction peut également échouer en raison du contrôle de compte d’utilisateur (UAC) sur Windows Vista et versions ultérieures. Si une application qui contient cette fonction est exécutée par un utilisateur connecté en tant que membre du groupe Administrateurs autre que l’administrateur intégré, cet appel échoue, sauf si l’application a été marquée dans le fichier manifeste avec un paramètre requestedExecutionLevel défini sur requireAdministrator. Si l’application ne dispose pas de ce fichier manifeste, un utilisateur connecté en tant que membre du groupe Administrateurs autre que l’administrateur intégré doit alors exécuter l’application dans un interpréteur de commandes amélioré en tant qu’administrateur intégré (administrateur d’exécution) pour que cette fonction réussisse.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	netioapi.h (inclure Iphlpapi.h)
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll