DeleteIpForwardEntry2, fonction
La fonction DeleteIpForwardEntry2 supprime une entrée de route IP sur un ordinateur local.
Syntaxe
NETIOAPI_API DeleteIpForwardEntry2(
_In_ const MIB_IPFORWARD_ROW2 *Row
);
Paramètres
- Ligne [in]
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
DeleteIpForwardEntry2 retourne STATUS_SUCCESS si la fonction réussit.
Si la fonction échoue, DeleteIpForwardEntry2 retourne l’un des codes d’erreur suivants :
| Code de retour | Description |
|---|---|
| STATUS_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 de la structure MIB_IPFORWARD_ROW2 vers laquelle pointe le paramètre Row n’a pas été spécifié, si le membre NextHop de la structure MIB_IPFORWARD_ROW2 n’a pas été spécifié ou si les membres InterfaceLuid et InterfaceIndex 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 le membre InterfaceLuid ou 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 ne se trouve 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 pointe le paramètre Row , ou 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 la fonction FormatMessage pour obtenir la chaîne de message pour l’erreur retournée. |
Notes
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 Row .
DestinationPrefix
Définissez sur un préfixe d’adresse IPv4 ou IPv6 valide et une famille.NextHop
Définissez sur une adresse et une famille IPv4 ou IPv6 valides.InterfaceLuid ou InterfaceIndex
Ces membres sont utilisés dans l’ordre indiqué 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.
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 de la structure MIB_IPFORWARD_ROW2 vers laquelle pointe 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 .
Votre pilote peut appeler la fonction GetIpForwardTable2 pour énumérer les entrées d’itinéraire IP sur un ordinateur local.
Spécifications
Plateforme cible |
Universal |
Version |
Disponible dans Windows Vista et les versions ultérieures des systèmes d’exploitation Windows. |
En-tête |
Netioapi.h (inclure Netioapi.h) |
Bibliothèque |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |