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. Lors du retour réussi, cette structure est mise à jour avec les propriétés de l’entrée de chemin d’accès IP.
Valeur de retour
getIpPathEntry retourne STATUS_SUCCESS si la fonction réussit.
Si la fonction échoue, GetIpPathEntry 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 un pointeur NULL est transmis dans le paramètre ligne, le membre si_family dans le membre de destination de la structure MIB_IPPATH_ROW que les points de paramètre ligne n’ont pas été définis sur AF_INET ou AF_INET6, ou les deux membres interfaceLuid et InterfaceIndex membres de la structure MIB_IPPATH_ROW n’ont pas été spécifiés. Cette erreur est également retournée si le membre si_family de la Source membre de la structure MIB_IPPATH_ROW ne correspondait pas à la famille d’adresses IP de destination et que 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 l'InterfaceLuid ou le membre 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 n’est située sur l’ordinateur local et qu’une adresse IPv4 a été spécifiée dans le source et membres de destination de la structure de MIB_IPPATH_ROW vers laquelle pointe le paramètre ligne, ou si aucune pile IPv6 n’est située sur l’ordinateur local et qu’une adresse IPv6 a été spécifiée dans le source et les membres de destination de destination. |
| autres | Utilisez la fonction FormatMessage pour obtenir la chaîne de message pour l’erreur retournée. |
Remarques
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 Ligne.
de 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 de la famille d’adresses IP de destination spécifiée dans le membre de destination ou sur AF_UNSPEC.InterfaceLuid ou InterfaceIndex
Ces membres sont utilisés dans l’ordre répertorié 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.
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 vers laquelle pointe le paramètre ligne.
Votre pilote peut appeler la fonction GetIpPathTable pour énumérer les entrées de chemin d’accès IP sur un ordinateur local.