Partager via


Fonction ConvertInterfaceNameToLuidA

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

Notes

La famille d’API ConvertInterfaceXxx énumère les identificateurs de toutes les interfaces liées à TCP/IP, qui peuvent inclure des miniports virtuels, des filtres légers, des adaptateurs tunnel et des interfaces physiques.

Syntaxe

NETIOAPI_API ConvertInterfaceNameToLuidA(
  _In_  const CHAR     *InterfaceName,
  _Out_       NET_LUID *InterfaceLuid
);

Paramètres

  • InterfaceName [in]
    Pointeur vers une chaîne ANSI terminée par null qui contient le nom de l’interface réseau.

  • InterfaceLuid [out]
    Pointeur vers l’union NET_LUID pour cette interface.

Valeur retournée

ConvertInterfaceNameToLuidA retourne STATUS_SUCCESS si la fonction réussit. Si la fonction échoue, ConvertInterfaceNameToLuidA retourne l’un des codes d’erreur suivants :

Code de retour Description
ERROR_BUFFER_OVERFLOW

La longueur du nom de l’interface ANSI n’est pas valide. ConvertInterfaceNameToLuidA retourne cette erreur si le paramètre InterfaceName dépasse la longueur de chaîne maximale autorisée pour ce paramètre.

STATUS_INVALID_NAME

Le nom de l’interface n’est pas valide. ConvertInterfaceNameToLuidA retourne cette erreur si le paramètre InterfaceName contient un nom d’interface non valide.

STATUS_INVALID_PARAMETER

L’un des paramètres n’est pas valide. ConvertInterfaceNameToLuidA retourne cette erreur si le paramètre InterfaceLuid a la valeur NULL.

Notes

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

La longueur maximale du nom de l’interface réseau, NDIS_IF_MAX_STRING_SIZE, sans la valeur NULL de fin, est définie dans le fichier d’en-tête Ntddndis.h. NDIS_IF_MAX_STRING_SIZE est défini comme étant la constante IF_MAX_STRING_SIZE, qui est définie dans le fichier d’en-tête Ifdef.h.

Notes

Les fichiers d’en-tête Ntddndis.h et Ifdef.h sont automatiquement inclus dans le fichier d’en-tête Netioapi.h . Vous ne devez jamais utiliser directement les fichiers d’en-tête Ntddndis.h et Ifdef.h .

Utilisez la fonction ConvertInterfaceNameToLuidW pour convertir un nom d’interface Unicode en LUID.

Spécifications

Plateforme cible

Universal

Version

Disponible dans Windows Vista et les versions ultérieures des systèmes d’exploitation Windows.

En-tête

Netioapi.h (inclure Netioapi.h)

Bibliothèque

Netio.lib

IRQL

PASSIVE_LEVEL

Voir aussi

ConvertInterfaceAliasToLuid

ConvertInterfaceGuidToLuid

ConvertInterfaceIndexToLuid

ConvertInterfaceLuidToAlias

ConvertInterfaceLuidToGuid

ConvertInterfaceLuidToIndex

ConvertInterfaceLuidToNameA

ConvertInterfaceLuidToNameW

ConvertInterfaceNameToLuidW

NET_LUID