GetIpPathEntry, fonction (netioapi.h)

Article
02/29/2024

La fonction GetIpPathEntry récupère les informations d’une entrée de chemin d’accès IP sur l’ordinateur local.

Syntaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpPathEntry(
  [in, out] PMIB_IPPATH_ROW Row
);

Paramètres

[in, out] Row

Pointeur vers une entrée de structure MIB_IPPATH_ROW pour une entrée de chemin d’accès IP. En cas de retour réussi, cette structure est mise à jour avec les propriétés de l’entrée de chemin d’accès IP.

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
ERROR_FILE_NOT_FOUND	Le système ne peut pas trouver le fichier spécifié. Cette erreur est retournée si l’interface réseau LUID ou l’index d’interface spécifié par le membre InterfaceLuid ou InterfaceIndex du MIB_IPPATH_ROW pointé par le paramètre Row n’est pas une valeur sur l’ordinateur local.
ERROR_INVALID_PARAMETER	Un paramètre est incorrect. Cette erreur est retournée si un pointeur NULL est transmis dans le paramètre Row , si le membre si_family dans le membre Destination du MIB_IPPATH_ROW pointé par le paramètre Row n’est pas défini sur AF_INET ou AF_INET6, ou si les deux membres InterfaceLuid ou InterfaceIndex du MIB_IPPATH_ROW pointés par le paramètre Row ne sont pas spécifiés. Cette erreur est également retournée si le membre si_family dans le membre source du MIB_IPPATH_ROW pointé par le paramètre Row ne correspond pas à la famille d’adresses IP de destination et si le si_family de l’adresse IP source n’est pas spécifié comme AF_UNSPEC.
ERROR_NOT_FOUND	Element not found. Cette erreur est retournée si l’interface réseau spécifiée par le membre InterfaceLuid ou InterfaceIndex de la structure MIB_IPPATH_ROW pointée par le paramètre Row ne correspond pas à l’adresse IP et à la famille d’adresses spécifiées dans le membre Destination dans la structure MIB_IPPATH_ROW .
ERROR_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 est spécifiée dans les membres Source et Destination du MIB_IPPATH_ROW pointés vers le paramètre Row . Cette erreur est également retournée si aucune pile IPv6 ne se trouve sur l’ordinateur local et qu’une adresse IPv6 est spécifiée dans les membres Source et Destination .
Autres	Utilisez FormatMessage pour obtenir la chaîne de message pour l’erreur retournée.

Remarques

La fonction GetIpPathEntry est définie sur Windows Vista et versions ultérieures.

La fonction GetIpPathEntry est utilisée pour récupérer une entrée de structure MIB_IPPATH_ROW .

Lors de l’entrée, le membre Destination dans la structure MIB_IPPATH_ROW pointée vers le paramètre Row doit être initialisé vers une adresse et une famille IPv4 ou IPv6 valides. La famille d’adresses spécifiée dans Membre source dans la structure MIB_IPPATH_ROW doit également correspondre à la famille d’adresses IP de destination spécifiée dans le membre de destination ou la famille d’adresses dans le membre source doit être spécifiée en tant que AF_UNSPEC. En outre , au moins l’un des membres suivants de la structure MIB_IPPATH_ROW pointée vers le paramètre Row doit être initialisé : InterfaceLuid ou InterfaceIndex.

Les champs sont utilisés dans l’ordre indiqué ci-dessus. Par conséquent, si l’interfaceLuid est spécifiée, ce membre est utilisé pour déterminer l’interface. Si aucune valeur n’est définie pour le membre InterfaceLuid (les valeurs de ce membre sont définies sur zéro), le membre InterfaceIndex est ensuite utilisé pour déterminer l’interface.

Lors de la sortie lorsque l’appel réussit, GetIpPathEntry récupère les autres propriétés de l’entrée de chemin d’accès IP et remplit la structure MIB_IPPATH_ROW pointée par le paramètre Row .

La fonction GetIpPathTable peut être appelée pour énumérer les entrées de chemin d’accès IP sur un ordinateur local.

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 (inclure Iphlpapi.h)
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll

Voir aussi

Partager via