FlushIpNetTable2, fonction
La fonction FlushIpNetTable2 vide la table voisin IP sur un ordinateur local.
Syntaxe
NETIOAPI_API FlushIpNetTable2(
_In_ ADDRESS_FAMILY Family,
_In_ NET_IFINDEX InterfaceIndex
);
Paramètres
Family [in]
Famille d’adresses à vider.Les valeurs possibles pour la famille d’adresses sont répertoriées dans le fichier d’en-tête Winsock2.h. Notez que les valeurs de la famille d’adresses AF_ et des constantes de famille de protocoles PF_ sont identiques (par exemple, AF_INET et PF_INET), afin de pouvoir utiliser l’une ou l’autre constante.
Sur Windows Vista et les versions ultérieures des systèmes d’exploitation Windows, les valeurs possibles pour le paramètre Family sont définies dans le fichier d’en-tête Ws2def.h. Notez que le fichier d’en-tête Ws2def.h est automatiquement inclus dans Netioapi.h et que vous ne devez jamais utiliser Ws2def.h directement.
Les valeurs suivantes sont actuellement prises en charge pour la famille d’adresses :
AF_INET
Famille d’adresses IPv4. Lorsque cette valeur est spécifiée, cette fonction vide la table d’adresses IP voisine qui contient uniquement des entrées IPv4.AF_INET6
Famille d’adresses IPv6. Lorsque cette valeur est spécifiée, cette fonction vide la table d’adresses IP voisine qui contient uniquement les entrées IPv6.AF_UNSPEC
La famille d’adresses n’est pas spécifiée. Lorsque cette valeur est spécifiée, cette fonction vide la table d’adresses IP voisine qui contient les entrées IPv4 et IPv6.
InterfaceIndex [in]
Index de l’interface. Si l’index est spécifié, la fonction vide les entrées d’adresse IP voisines sur une interface spécifique. Ootherwise, la fonction vide les entrées d’adresse IP voisines sur toutes les interfaces. Pour ignorer l’interface, définissez ce paramètre sur zéro.
Valeur de retour
FlushIpNetTable2 retourne STATUS_SUCCESS si la fonction réussit.
Si la fonction échoue, FlushIpNetTable2 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 le paramètre famille n’a pas été spécifié comme AF_INET, AF_INET6 ou AF_UNSPEC. |
| 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 que AF_INET a été spécifié dans le paramètre famille, ou si aucune pile IPv6 n’est située sur l’ordinateur local et que AF_INET6 a été spécifié dans le paramètre Family. Cette erreur est également retournée sur les versions de Windows où cette fonction n’est pas prise en charge. |
| autres | Utilisez la fonction FormatMessage pour obtenir la chaîne de message pour l’erreur retournée. |
Remarques
La fonction FlushIpNetTable2 vide ou supprime les adresses IP voisines sur un ordinateur local. Votre pilote peut utiliser le paramètre Family pour limiter les adresses IP voisines à supprimer à une famille d’adresses IP particulière. Si les adresses IP voisines pour IPv4 et IPv6 doivent être supprimées, votre pilote doit définir le paramètre famille sur AF_UNSPEC. Votre pilote peut utiliser le paramètre InterfaceIndex pour limiter les adresses IP voisines à supprimer à une interface particulière. Si les adresses IP voisines de toutes les interfaces doivent être supprimées, votre pilote doit définir le paramètre interfaceIndex sur zéro.
Votre pilote doit initialiser le paramètre Family sur AF_INET, AF_INET6 ou AF_UNSPEC.