GetIpPathEntry, fonction
La fonction GetIpPathEntry récupère des informations pour une entrée de chemin d’accès IP sur un ordinateur local.
Syntaxe
NETIOAPI_API GetIpPathEntry(
_Inout_ PMIB_IPPATH_ROW Row
);
Paramètres
- Ligne [in, out]
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
GetIpPathEntry retourne STATUS_SUCCESS si la fonction réussit.
Si la fonction échoue, GetIpPathEntry 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 si_family dans le membre Destination de la structure MIB_IPPATH_ROW vers laquelle le paramètre Row pointe n’a pas été défini sur AF_INET ou AF_INET6, ou si les membres InterfaceLuid et InterfaceIndex de la structure MIB_IPPATH_ROW n’ont pas été spécifiés. Cette erreur est également retournée si le membre si_family dans le membre source de la structure MIB_IPPATH_ROW ne correspond pas à la famille d’adresses IP de destination et si le si_family de l’adresse IP source n’a pas été spécifié comme AF_UNSPEC. |
| 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_IPPATH_ROW 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 les membres Source et Destination de la structure MIB_IPPATH_ROW 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 les membres Source et Destination . |
| Autres | Utilisez la fonction FormatMessage pour obtenir la chaîne de message pour l’erreur retournée. |
Notes
La fonction GetIpPathEntry est utilisée pour récupérer une entrée de structure MIB_IPPATH_ROW .
Lors de l’entrée, votre pilote doit initialiser les membres suivants de la structure MIB_IPPATH_ROW vers laquelle pointe le paramètre Row .
Destination
Définissez sur une adresse et une famille IPv4 ou IPv6 valides.Source
Définissez la famille d’adresses spécifiée dans le membre source sur la famille d’adresses IP de destination spécifiée dans le membre destination , ou sur AF_UNSPEC.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.
En 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 vers laquelle pointe le paramètre Row .
Votre pilote peut appeler la fonction GetIpPathTable pour énumérer les entrées de chemin d’accès 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 |