GetIpNetEntry2, fonction (netioapi.h)

Article
03/04/2024

La fonction GetIpNetEntry2 récupère les informations d’une entrée d’adresse IP voisine sur l’ordinateur local.

Syntaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpNetEntry2(
  [in, out] PMIB_IPNET_ROW2 Row
);

Paramètres

[in, out] Row

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

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_IPNET_ROW2 pointé vers le paramètre Row n’était pas une valeur sur l’ordinateur local.
ERROR_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 Address du MIB_IPNET_ROW2 pointé par le paramètre Row n’a pas été défini sur une adresse IPv4 ou IPv6 voisine valide, ou si les deux membres InterfaceLuid ou InterfaceIndex du MIB_IPNET_ROW2 pointés par le paramètre Row n’ont pas été spécifiés.
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_IPNET_ROW2 pointée par le paramètre Row ne correspond pas à l’adresse IP voisine et à la famille d’adresses spécifiées dans le membre Address dans la structure MIB_IPNET_ROW2 .
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 a été spécifiée dans le membre Address de la structure MIB_IPNET_ROW2 pointée 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 a été spécifiée dans le membre Address de la structure MIB_IPNET_ROW2 .
Autres	Utilisez FormatMessage pour obtenir la chaîne de message pour l’erreur retournée.

Remarques

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

La fonction GetIpNetEntry2 est utilisée pour récupérer une entrée de structure MIB_IPNET_ROW2 .

Lors de l’entrée, le membre Address dans la structure MIB_IPNET_ROW2 pointée par le paramètre Row doit être initialisé vers une adresse et une famille IPv4 ou IPv6 voisines valides. En outre, au moins l’un des membres suivants de la structure MIB_IPNET_ROW2 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’a été définie pour le membre InterfaceLuid (les valeurs de ce membre ont été 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, GetIpNetEntry2 récupère les autres propriétés de l’adresse IP voisine et remplit la structure MIB_IPNET_ROW2 pointée vers le paramètre Row .

La fonction GetIpNetTable2 peut être appelée pour énumérer les entrées d’adresse IP voisines 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