Partager via


DeleteIpForwardEntry2, fonction

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

Syntaxe

NETIOAPI_API DeleteIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Row
);

Paramètres

  • de ligne [in]
    Pointeur vers une entrée de structure MIB_IPFORWARD_ROW2 pour une entrée d’itinéraire IP. Lors d’un retour réussi, cette entrée est supprimée.

Valeur de retour

DeleteIpForwardEntry2 retourne STATUS_SUCCESS si la fonction réussit.

Si la fonction échoue, DeleteIpForwardEntry2 retourne l’un des codes d’erreur suivants :

Retourner le code Description
STATUS_INVALID_PARAMETER

Un paramètre non valide a été passé à la fonction. Cette erreur est retournée si un pointeur NULL est transmis dans le paramètre ligne, le membre destinationPrefix de la structure MIB_IPFORWARD_ROW2 que le paramètre ligne point à n’a pas été spécifié, le membre NextHop de la structure MIB_IPFORWARD_ROW2 n’a pas été spécifié, ou les deux membres InterfaceLuid et InterfaceIndex membres de la structure MIB_IPFORWARD_ROW2 n’ont pas été spécifiés.

STATUS_NOT_FOUND

L’interface spécifiée est introuvable. Cette erreur est retournée si la fonction ne trouve pas l’interface réseau spécifiée par l'InterfaceLuid ou membre InterfaceIndex de la structure MIB_IPFORWARD_ROW2 vers laquelle pointe le paramètre Row.

STATUS_NOT_SUPPORTED

La demande n’est pas prise en charge. Cette erreur est retournée si aucune pile IPv4 n’est située sur l’ordinateur local et qu’une adresse IPv4 a été spécifiée dans le membre Address de la structure MIB_IPFORWARD_ROW2 vers laquelle le paramètre Ligne pointe, ou si aucune pile IPv6 n’est située sur l’ordinateur local et qu’une adresse IPv6 a été spécifiée dans le membre Address.

autres

Utilisez la fonction FormatMessage pour obtenir la chaîne de message pour l’erreur retournée.

Remarques

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

Lors de l’entrée, votre pilote doit initialiser les membres suivants de la structure MIB_IPFORWARD_ROW2 vers laquelle pointe le paramètre Ligne.

  • DestinationPrefix
    Définissez sur un préfixe et une famille d’adresses IPv4 ou IPv6 valides.

  • NextHop
    Définissez sur une adresse et une famille IPv4 ou IPv6 valides.

  • InterfaceLuid ou InterfaceIndex
    Ces membres sont utilisés dans l’ordre répertorié précédemment. Par conséquent, si InterfaceLuid est spécifié, ce membre est utilisé pour déterminer l’interface. Si aucune valeur n’a été définie pour le membre InterfaceLuid (la valeur de ce membre a été définie sur zéro), le membre InterfaceIndex est ensuite utilisé pour déterminer l’interface.

En sortie, lorsque l’appel réussit, DeleteIpForwardEntry2 supprime l’entrée d’itinéraire IP.

La fonction DeleteIpForwardEntry2 échoue si le DestinationPrefix et les membres NextHop de la structure MIB_IPFORWARD_ROW2 que le paramètre Row pointe pour ne pas correspondre à une entrée d’itinéraire IP existante sur l’interface spécifiée dans le interface ou les membres InterfaceIndex.

Votre pilote peut appeler la fonction GetIpForwardTable2 pour énumérer les entrées d’itinéraire IP sur un ordinateur local.

Exigences

Plateforme cible

universel

Version

Disponible dans Windows Vista et versions ultérieures des systèmes d’exploitation Windows.

En-tête

Netioapi.h (include Netioapi.h)

Bibliothèque

Netio.lib

IRQL

< DISPATCH_LEVEL

Voir aussi

CreateIpForwardEntry2

GetBestRoute2

GetIpForwardEntry2

GetIpForwardTable2

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

NotifyRouteChange2

SetIpForwardEntry2