Fonction GetIfEntry2Ex (netioapi.h)

Article
08/25/2023

La fonction GetIfEntry2Ex récupère le niveau d’informations spécifié pour l’interface spécifiée sur l’ordinateur local.

Syntaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIfEntry2Ex(
  [in]      MIB_IF_ENTRY_LEVEL Level,
  [in, out] PMIB_IF_ROW2       Row
);

Paramètres

[in] Level

Niveau d’informations d’interface à récupérer. Ce paramètre peut être l’une des valeurs du type d’énumération MIB_IF_ENTRY_LEVEL défini dans le fichier d’en-tête Netioapi.h .

Valeur	Signification
MibIfEntryNormal 0	Les valeurs de statistiques et d’état retournées dans les membres de la structure MIB_IF_ROW2 pointées par le paramètre Row sont retournées par le haut de la pile de filtres.
MibIfEntryNormalWithoutStatistics 2	Les valeurs d’état (sans statistiques) retournées dans les membres de la structure MIB_IF_ROW2 pointées par le paramètre Row sont retournées par le haut de la pile de filtres.

[in, out] Row

Pointeur vers une structure de MIB_IF_ROW2 qui, en cas de retour réussi, reçoit des informations pour une interface sur l’ordinateur local. Lors de l’entrée, le membre InterfaceLuid ou InterfaceIndex du MIB_IF_ROW2 doit être défini sur l’interface pour laquelle récupérer des informations.

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_IF_ROW2 pointé vers le paramètre Rown’é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 paramètre NULL est passé dans le paramètre Row . Cette erreur est également retournée si les membres InterfaceLuid et InterfaceIndex du MIB_IF_ROW2 pointés par le paramètre Row ne sont pas spécifiés.
Autres	Utilisez la fonction FormatMessage pour obtenir la chaîne de message pour l’erreur retournée.

Remarques

The
La fonction GetIfEntry2Ex récupère les informations d’une interface spécifiée sur un système local et retourne ces informations dans un pointeur vers un système local
MIB_IF_ROW2 structure. GetIfEntry2Ex est une version améliorée de la fonction GetIfEntry2 qui permet de sélectionner le niveau d’informations d’interface à récupérer.

Lors de l’entrée, au moins l’un des membres suivants de la structure MIB_IF_ROW2 passée dans 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 (la valeur de ce membre a été définie sur zéro), le membre InterfaceIndex est ensuite utilisé pour déterminer l’interface.

À la sortie, les champs restants de la structure MIB_IF_ROW2 pointée vers le paramètre Row sont renseignés.

Notez que le fichier d’en-tête Netioapi.h est automatiquement inclus dans le fichier d’en-tête Iphlpapi.h et ne doit jamais être utilisé directement.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 10, version 1703 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2016 (applications de bureau uniquement)
Plateforme cible	Windows
En-tête	netioapi.h (inclure Iphlpapi.h)
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll