GetIpPathTable, fonction (netioapi.h)
La fonction GetIpPathTable récupère la table de chemins d’accès IP sur l’ordinateur local.
Syntaxe
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpPathTable(
[in] ADDRESS_FAMILY Family,
[out] PMIB_IPPATH_TABLE *Table
);
Paramètres
[in] Family
Famille d’adresses à récupérer.
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), de sorte que l’une ou l’autre constante peut être utilisée.
Sur le SDK Windows publié pour Windows Vista et versions ultérieures, la organization des fichiers d’en-tête a changé et les valeurs possibles pour ce membre 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 Winsock2.h et ne doit jamais être utilisé directement.
Les valeurs actuellement prises en charge sont AF_INET, AF_INET6 et AF_UNSPEC.
[out] Table
Pointeur vers une structure de MIB_IPPATH_TABLE qui contient une table d’entrées de chemin d’accès IP sur l’ordinateur local.
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 |
|---|---|
|
Un paramètre non valide a été transmis à la fonction. Cette erreur est retournée si un pointeur NULL est passé dans le paramètre Table ou si le paramètre Family n’a pas été spécifié comme AF_INET, AF_INET6 ou AF_UNSPEC. |
|
Les ressources de mémoire sont insuffisantes pour terminer l’opération. |
|
Aucune entrée de chemin d’accès IP spécifiée dans le paramètre Family n’a été trouvée. |
|
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 si AF_INET a été spécifié dans le paramètre Family . Cette erreur est également retournée si aucune pile IPv6 n’est 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. |
|
Utilisez FormatMessage pour obtenir la chaîne de message de l’erreur retournée. |
Remarques
La fonction GetIpPathTable est définie sur Windows Vista et versions ultérieures.
The
La fonction GetIpPathTable énumère les entrées de chemin d’accès IP sur un système local et retourne ces informations dans une structure de MIB_IPPATH_TABLE .
Les entrées de chemin d’accès IP sont retournées dans une structure MIB_IPPATH_TABLE dans la mémoire tampon vers laquelle pointe le paramètre Table . La structure MIB_IPPATH_TABLE contient un nombre d’entrées de chemin d’accès IP et un tableau de structures MIB_IPPATH_ROW pour chaque entrée de chemin d’accès IP. Lorsque ces structures retournées ne sont plus nécessaires, libérez la mémoire en appelant FreeMibTable.
Le paramètre Family doit être initialisé sur AF_INET, AF_INET6 ou AF_UNSPEC.
Notez que la structure de MIB_IPPATH_TABLE retournée pointée par le paramètre Table peut contenir un remplissage pour l’alignement entre le membre NumEntries et la première entrée de tableau MIB_IPPATH_ROW dans le membre Table de la structure MIB_IPPATH_TABLE . Un remplissage pour l’alignement peut également être présent entre les entrées de tableau MIB_IPPATH_ROW . Tout accès à une entrée de tableau MIB_IPPATH_ROW doit supposer qu’un remplissage peut exister.
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 (include Iphlpapi.h) |
| Bibliothèque | Iphlpapi.lib |
| DLL | Iphlpapi.dll |