Fonction ConvertInterfaceLuidToNameA
La fonction ConvertInterfaceLuidToNameA convertit un identificateur local unique (LUID) pour une interface réseau en nom d’interface ANSI.
Notes
La famille d’API ConvertInterfaceXxx énumère les identificateurs sur toutes les interfaces liées à TCP/IP, qui peuvent inclure des miniports virtuels, des filtres légers, des adaptateurs de tunnel et des interfaces physiques.
Syntaxe
NETIOAPI_API ConvertInterfaceLuidToNameA(
_In_ const NET_LUID *InterfaceLuid,
_Out_ PSTR InterfaceName,
_In_ SIZE_T Length
);
Paramètres
InterfaceLuid [in]
Pointeur vers une union NET_LUID pour une interface réseau.InterfaceName [out]
Pointeur vers une mémoire tampon pour contenir la chaîne ANSI terminée par NULL. Si ConvertInterfaceLuidToNameA retourne correctement, InterfaceName contient le nom de l’interface ANSI.Longueur [in]
Longueur, en octets, de la mémoire tampon vers laquelle pointe le paramètre InterfaceName . Cette valeur doit être suffisamment grande pour contenir le nom de l’interface et le caractère NULL de fin. La longueur maximale autorisée est NDIS_IF_MAX_STRING_SIZE + 1. Pour plus d’informations sur NDIS_IF_MAX_STRING_SIZE, consultez la section Remarques suivante.
Valeur retournée
ConvertInterfaceLuidToNameA retourne STATUS_SUCCESS si la fonction réussit. Si la fonction échoue, ConvertInterfaceLuidToNameA retourne l’un des codes d’erreur suivants :
Code de retour | Description |
---|---|
STATUS_INVALID_PARAMETER | L’un des paramètres n’est pas valide. ConvertInterfaceLuidToNameA renvoie cette erreur si InterfaceLuid ou InterfaceName a la valeur NULL, ou si InterfaceLuid n’est pas valide. |
STATUS_NOT_ENOUGH_MEMORY | ConvertInterfaceLuidToNameA renvoie cette erreur si la mémoire tampon InterfaceName n’était pas aussi volumineuse que celle spécifiée dans le paramètre Length et, par conséquent, la mémoire tampon ne pouvait pas contenir le nom de l’interface. |
Notes
La fonction ConvertInterfaceLuidToNameA est indépendante du protocole et fonctionne avec des interfaces réseau pour les protocoles IPv6 et IPv4.
La longueur maximale du nom d’une interface réseau, NDIS_IF_MAX_STRING_SIZE, sans le caractère 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 les fichiers d’en-tête Ntddndis.h et Ifdef.h directement.
Utilisez la fonction ConvertInterfaceLuidToNameW pour convertir une interface réseau LUID en nom d’interface Unicode.
Spécifications
Plateforme cible |
Universal |
Version |
Disponible dans Windows Vista et versions ultérieures des systèmes d’exploitation Windows. |
En-tête |
Netioapi.h (inclure Netioapi.h) |
Bibliothèque |
Netio.lib |
IRQL |
PASSIVE_LEVEL |