Fonction ConvertInterfaceNameToLuidA (netioapi.h)

Article
02/29/2024

La fonction ConvertInterfaceNameToLuidA convertit un nom d’interface réseau ANSI en identificateur local unique (LUID) de l’interface.

Syntaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceNameToLuidA(
  [in]  const CHAR *InterfaceName,
  [out] NET_LUID   *InterfaceLuid
);

Paramètres

[in] InterfaceName

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

[out] InterfaceLuid

Pointeur vers le NET_LUID pour cette interface.

Valeur retournée

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

Code d'erreur	Signification
ERROR_BUFFER_OVERFLOW	La longueur du nom de l’interface ANSI n’était pas valide. Cette erreur est retournée si le paramètre InterfaceName a dépassé la longueur de chaîne maximale autorisée pour ce paramètre.
ERROR_INVALID_NAME	Le nom de l’interface n’était pas valide. Cette erreur est retournée si le paramètre InterfaceName contenait un nom non valide.
ERROR_INVALID_PARAMETER	L'un des paramètres n'était pas valide. Cette erreur est retournée si le paramètre InterfaceLuid était NULL.

Remarques

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

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

ConvertInterfaceNameToLuidW convertit un nom d’interface Unicode en LUID.

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