ConvertInterfaceLuidToAlias-Funktion (netioapi.h)

Artikel
02/29/2024

Die ConvertInterfaceLuidToAlias-Funktion konvertiert einen lokal eindeutigen Bezeichner (LUID) für eine Netzwerkschnittstelle in einen Schnittstellenalias.

Syntax

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

Parameter

[in] InterfaceLuid

Ein Zeiger auf eine NET_LUID für eine Netzwerkschnittstelle.

[out] InterfaceAlias

Ein Zeiger auf einen Puffer, der die MIT NULL beendete Unicode-Zeichenfolge enthält, die den Aliasnamen der Netzwerkschnittstelle enthält, wenn die Funktion erfolgreich zurückgegeben wird.

[in] Length

Die Länge des Puffers in Zeichen, auf den der Parameter InterfaceAlias verweist. Dieser Wert muss groß genug sein, um den Aliasnamen der Netzwerkschnittstelle und das endende NULL-Zeichen aufzunehmen. Die maximal erforderliche Länge ist NDIS_IF_MAX_STRING_SIZE + 1.

Rückgabewert

Bei Erfolg gibt ConvertInterfaceLuidToAlias NO_ERROR zurück. Jeder Rückgabewert ungleich null gibt einen Fehler an.

Fehlercode	Bedeutung
ERROR_INVALID_PARAMETER	Einer der Parameter war ungültig. Dieser Fehler wird zurückgegeben, wenn entweder der Parameter InterfaceLuid oder InterfaceAliasNULL ist oder wenn der Parameter InterfaceLuid ungültig war.
ERROR_NOT_ENOUGH_MEMORY	Für die Verarbeitung dieses Befehls ist nicht genügend Speicherplatz verfügbar. Dieser Fehler wird zurückgegeben, wenn die Größe des Puffers, auf den der Parameter InterfaceAlias verweist, nicht groß genug war, wie im Length-Parameter angegeben, um den Aliasnamen zu speichern.

Hinweise

Die ConvertInterfaceLuidToAlias-Funktion ist unter Windows Vista und höher verfügbar.

Die ConvertInterfaceLuidToAlias-Funktion ist protokollunabhängig und funktioniert mit Netzwerkschnittstellen für das IPv6- und IPv4-Protokoll.

Die maximale Länge des Aliasnamens für eine Netzwerkschnittstelle , NDIS_IF_MAX_STRING_SIZE, ohne dass der beendete NULL-Wert in der Headerdatei "Ntddndis.h " deklariert wird. Die NDIS_IF_MAX_STRING_SIZE wird als die IF_MAX_STRING_SIZE Konstante definiert, die in der Headerdatei Ifdef.h definiert ist. Die Headerdateien "Ntddndis.h" und " Ifdef.h " werden automatisch in die Headerdatei "Netioapi.h " eingeschlossen, die automatisch von der Iphlpapi.h-Headerdatei eingeschlossen wird. Die Headerdateien Ntddndis.h, Ifdef.h und Netioapi.h sollten niemals direkt verwendet werden.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	netioapi.h (include Iphlpapi.h)
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll