Fonction ConvertInterfaceLuidToNameA (netioapi.h)

Article
08/25/2023

La fonction ConvertInterfaceLuidToNameA convertit un identificateur local unique (LUID) pour une interface réseau en nom d’interface ANSI.

Syntaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceLuidToNameA(
  [in]  const NET_LUID *InterfaceLuid,
  [out] PSTR           InterfaceName,
  [in]  SIZE_T         Length
);

Paramètres

[in] InterfaceLuid

Pointeur vers un NET_LUID pour 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.

[in] Length

Longueur, en octets, de la mémoire tampon pointée vers le paramètre InterfaceName . Cette valeur doit être suffisamment grande pour prendre en charge le nom de l’interface et le caractère null de fin. La longueur maximale requise est NDIS_IF_MAX_STRING_SIZE + 1.

Valeur retournée

En cas de réussite, ConvertInterfaceLuidToNameA retourne NETIO_ERROR_SUCCESS. Toute valeur de retour différente de zéro indique un échec.

Code d'erreur	Signification
ERROR_INVALID_PARAMETER	L'un des paramètres n'était pas valide. Cette erreur est retournée si le paramètre InterfaceLuid ou InterfaceName était NULL ou si le paramètre InterfaceLuid n’était pas valide.
ERROR_NOT_ENOUGH_MEMORY	Le stockage disponible est insuffisant pour traiter cette commande. Cette erreur est retournée si la taille de la mémoire tampon pointée vers le paramètre InterfaceName n’était pas suffisamment grande, comme spécifié dans le paramètre Length pour contenir le nom de l’interface.

Remarques

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

La fonction ConvertInterfaceLuidToNameA est indépendante du protocole et fonctionne avec les interfaces réseau pour les protocoles IPv6 et IPv4. ConvertInterfaceLuidToNameA convertit une interface réseau LUID en nom d’interface ANSI.

ConvertInterfaceLuidToNameW convertit une interface réseau LUID en nom d’interface Unicode.

La longueur maximale d’un nom d’interface, NDIS_IF_MAX_STRING_SIZE, sans la valeur 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 (inclure Iphlpapi.h)
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll