FlushIpPathTable, fonction
La fonction FlushIpPathTable vide la table de chemins d’accès IP sur un ordinateur local.
Syntaxe
NETIOAPI_API FlushIpPathTable(
_In_ ADDRESS_FAMILY Family
);
Paramètres
Famille [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 protocole PF_ sont identiques (par exemple, AF_INET et PF_INET). Vous pouvez donc 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 de chemins d’accès IP 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 de chemins d’accès IP qui contient uniquement des 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.
Valeur retournée
FlushIpPathTable retourne STATUS_SUCCESS si la fonction réussit.
Si la fonction échoue, FlushIpPathTable 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 le paramètre Family 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 ne se trouve sur l’ordinateur local et AF_INET a été spécifié dans le paramètre Family , ou si aucune pile IPv6 ne se trouve sur l’ordinateur local et 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 de l’erreur retournée. |
Notes
La fonction FlushIpPathTable vide ou supprime les entrées de chemin d’accès IP sur un ordinateur local. Votre pilote peut utiliser le paramètre Family pour limiter les entrées de chemin d’accès IP à supprimer à une famille d’adresses IP particulière. Si les entrées de chemin d’accès IP pour IPv4 et IPv6 doivent être supprimées, votre pilote doit définir le paramètre Family sur AF_UNSPEC.
Votre pilote doit initialiser le paramètre Family pour AF_INET, AF_INET6 ou AF_UNSPEC.
Spécifications
Plateforme cible |
Universal |
Version |
Disponible dans Windows Vista et versions ultérieures des systèmes d’exploitation Windows. |
En-tête |
Netioapi.h (inclure Netioapi.h) |
Bibliothèque |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |