if_indextoname, fonction (netioapi.h)

Article
08/25/2023

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

Syntaxe

IPHLPAPI_DLL_LINKAGE PCHAR NETIOAPI_API_ if_indextoname(
  [in]  NET_IFINDEX InterfaceIndex,
  [out] PCHAR       InterfaceName
);

Paramètres

[in] InterfaceIndex

Index local d’une interface réseau.

[out] InterfaceName

Pointeur vers une mémoire tampon pour contenir la chaîne ANSI terminée par NULL contenant le nom de l’interface lorsque la fonction retourne correctement. La longueur, en octets, de la mémoire tampon pointée par ce paramètre doit être égale ou supérieure à IF_NAMESIZE.

Valeur retournée

En cas de réussite, if_indextoname retourne un pointeur vers une chaîne ANSI terminée par NULL contenant le nom de l’interface. En cas d’échec, un pointeur NULL est retourné.

Remarques

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

La fonction if_indextoname mappe un index d’interface dans son nom 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_indextoname 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_indextoname peut être remplacée par un appel à la fonction ConvertInterfaceIndexToLuid pour convertir un index d’interface en un NET_LUID suivi d’un appel à ConvertInterfaceLuidToNameA pour convertir le NET_LUID en nom d’interface ANSI.

Si le if_indextoname échoue et retourne un pointeur NULL , il n’est pas possible de déterminer un code d’erreur.

La longueur, en octets, de la mémoire tampon pointée par le paramètre InterfaceName doit être égale ou supérieure à IF_NAMESIZE, valeur déclarée dans le fichier d’en-tête Netioapi.h égale à NDIS_IF_MAX_STRING_SIZE. La longueur maximale d’un nom d’interface, NDIS_IF_MAX_STRING_SIZE, sans null de fin est déclarée dans le fichier d’en-tête Ntddndis.h . Le NDIS_IF_MAX_STRING_SIZE est défini comme étant la constante IF_MAX_STRING_SIZE définie dans le fichier d’en-tête Ifdef.h . Les fichiers d’en-tête Ntddndis.h et Ifdef.h sont automatiquement inclus dans le fichier d’en-tête Netioapi.h qui est automatiquement inclus par le fichier d’en-tête Iphlpapi.h . Les fichiers d’en-tête Ntddndis.h, Ifdef.h et Netioapi.h ne doivent jamais être utilisés directement.

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 (include Iphlpapi.h)
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll