Fonction ConvertInterfaceLuidToAlias
La fonction ConvertInterfaceLuidToAlias convertit un identificateur local unique (LUID) pour une interface réseau en alias d’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 ConvertInterfaceLuidToAlias(
_In_ const NET_LUID *InterfaceLuid,
_Out_ PWSTR InterfaceAlias,
_In_ SIZE_T Length
);
Paramètres
InterfaceLuid [in]
Pointeur vers une union de NET_LUID pour l’interface réseau.InterfaceAlias [out]
Pointeur vers une mémoire tampon pour contenir la chaîne Unicode terminée par NULL. Si ConvertInterfaceLuidToAlias retourne correctement, InterfaceAlias contient le nom d’alias de l’interface réseau.Longueur [in]
Longueur, par nombre de caractères, de la mémoire tampon vers laquelle pointe le paramètre InterfaceAlias . Cette valeur doit être suffisamment grande pour contenir le nom d’alias de l’interface réseau 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
ConvertInterfaceLuidToAlias retourne STATUS_SUCCESS si la fonction réussit. Si la fonction échoue, ConvertInterfaceLuidToAlias retourne l’un des codes d’erreur suivants :
| Code de retour | Description |
|---|---|
| STATUS_INVALID_PARAMETER | L’un des paramètres n’est pas valide. ConvertInterfaceLuidToAlias retourne cette erreur si InterfaceLuid ou InterfaceAlias a la valeur NULL ou si InterfaceLuid n’est pas valide. |
| STATUS_NOT_ENOUGH_MEMORY | Le stockage disponible est insuffisant. ConvertInterfaceLuidToAlias retourne cette erreur si la taille de la mémoire tampon vers laquelle pointe le paramètre InterfaceAlias n’était pas aussi grande 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’alias. |
Notes
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 le caractère NULL de fin, est déclarée 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 .
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 |