if_nametoindex, fonction (netioapi.h)

Article
02/29/2024

La fonction if_nametoindex convertit le nom d’interface ANSI d’une interface réseau en index local de l’interface.

Syntaxe

IPHLPAPI_DLL_LINKAGE NET_IFINDEX NETIOAPI_API_ if_nametoindex(
  [in] PCSTR InterfaceName
);

Paramètres

[in] InterfaceName

Pointeur vers une chaîne ANSI terminée par null contenant le nom de l’interface.

Valeur retournée

En cas de réussite, if_nametoindex retourne l’index d’interface locale. En cas d’échec, zéro est retourné.

Remarques

La fonction if_nametoindex est disponible sur Windows Vista et versions ultérieures.

La fonction if_nametoindex mappe un nom d’interface à son index correspondant. Cette fonction est conçue dans le cadre des extensions de socket de base pour IPv6, comme décrit par l’IETF dans RFC 2553. Pour plus d’informations, consultez http://www.ietf.org/rfc/rfc2553.txt.

La fonction if_nametoindex est implémentée pour la portabilité des applications avec des environnements Unix, mais les fonctions ConvertInterface sont préférées. La fonction if_nametoindex peut être remplacée par un appel à la fonction ConvertInterfaceNameToLuidA pour convertir le nom de l’interface ANSI en un NET_LUID suivi d’un appel à convertInterfaceLuidToIndex pour convertir le NET_LUID en index d’interface local.

Si la fonction if_nametoindex échoue et retourne zéro, il n’est pas possible de déterminer un code d’erreur.

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