Fonction ConvertInterfaceLuidToAlias (netioapi.h)

Article
03/04/2024

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

Syntaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceLuidToAlias(
  [in]  const NET_LUID *InterfaceLuid,
  [out] PWSTR          InterfaceAlias,
  [in]  SIZE_T         Length
);

Paramètres

[in] InterfaceLuid

Pointeur vers un NET_LUID pour une interface réseau.

[out] InterfaceAlias

Pointeur vers une mémoire tampon pour contenir la chaîne Unicode terminée par null contenant le nom d’alias de l’interface réseau lorsque la fonction retourne correctement.

[in] Length

Longueur, en caractères, de la mémoire tampon vers laquelle pointe le paramètre InterfaceAlias . Cette valeur doit être suffisamment grande pour prendre en charge le nom d’alias de l’interface réseau 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, ConvertInterfaceLuidToAlias retourne NO_ERROR. 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 InterfaceAlias était NULL ou si le paramètre InterfaceLuid n’était pas valide.
ERROR_NOT_ENOUGH_MEMORY	L’espace de stockage disponible est insuffisant pour traiter cette commande. Cette erreur est retournée si la taille de la mémoire tampon pointée par le paramètre InterfaceAlias n’était pas suffisamment grande, comme spécifié dans le paramètre Length pour contenir le nom de l’alias.

Remarques

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

La fonction ConvertInterfaceLuidToAlias est indépendante du protocole et fonctionne avec les interfaces réseau pour les protocoles IPv6 et IPv4.

La longueur maximale du nom d’alias d’une interface réseau, 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 (include Iphlpapi.h)
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll