Freigeben über


ConvertInterfaceLuidToAlias-Funktion

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

Hinweis

Die ConvertInterfaceXxx-API-Familie listet Bezeichner über alle Schnittstellen auf, die an TCP/IP gebunden sind, was virtuelle Miniports, lightweight-Filter, Tunneladapter und physische Schnittstellen umfassen kann.

Syntax

NETIOAPI_API ConvertInterfaceLuidToAlias(
  _In_  const NET_LUID *InterfaceLuid,
  _Out_       PWSTR    InterfaceAlias,
  _In_        SIZE_T   Length
);

Parameter

  • InterfaceLuid [in]
    Ein Zeiger auf eine NET_LUID Union für die Netzwerkschnittstelle.

  • InterfaceAlias [out]
    Ein Zeiger auf einen Puffer, der die MIT NULL endende Unicode-Zeichenfolge enthält. Wenn ConvertInterfaceLuidToAlias erfolgreich zurückgegeben wird, enthält InterfaceAlias den Aliasnamen der Netzwerkschnittstelle.

  • Länge [in]
    Die Länge nach Zeichenanzahl des Puffers, auf den der Parameter InterfaceAlias verweist. Dieser Wert muss groß genug sein, um den Aliasnamen der Netzwerkschnittstelle und das abschließende NULL-Zeichen zu enthalten. Die maximal zulässige Länge ist NDIS_IF_MAX_STRING_SIZE + 1. Weitere Informationen zu NDIS_IF_MAX_STRING_SIZE finden Sie im folgenden Abschnitt "Hinweise".

Rückgabewert

ConvertInterfaceLuidToAlias gibt STATUS_SUCCESS zurück, wenn die Funktion erfolgreich ist. Wenn die Funktion fehlschlägt, gibt ConvertInterfaceLuidToAlias einen der folgenden Fehlercodes zurück:

Rückgabecode Beschreibung
STATUS_INVALID_PARAMETER

Einer der Parameter ist ungültig. ConvertInterfaceLuidToAlias gibt diesen Fehler zurück, wenn Entweder InterfaceLuid oder InterfaceAliasNULL ist oder Wenn InterfaceLuid ungültig ist.

STATUS_NOT_ENOUGH_MEMORY

Nicht genügend Speicher ist verfügbar. ConvertInterfaceLuidToAlias gibt diesen Fehler zurück, wenn die Größe des Puffers, auf den der Parameter InterfaceAlias verweist, nicht so groß war, wie im Length-Parameter angegeben, und daher konnte der Puffer den Aliasnamen nicht enthalten.

Bemerkungen

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

Die maximale Länge des Aliasnamens für eine Netzwerkschnittstelle, NDIS_IF_MAX_STRING_SIZE, ohne dass das NULL-Zeichen beendet wird, wird in der Headerdatei "Ntddndis.h " deklariert. NDIS_IF_MAX_STRING_SIZE wird als die IF_MAX_STRING_SIZE-Konstante definiert, die in der Ifdef.h-Headerdatei definiert ist.

Hinweis

Die Headerdateien "Ntddndis.h" und "Ifdef.h " werden automatisch in die Headerdatei "Netioapi.h " eingeschlossen. Sie sollten die Headerdateien Ntddndis.h und Ifdef.h niemals direkt verwenden.

Anforderungen

Zielplattform

Universell

Version

Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme.

Header

Netioapi.h (netioapi.h einschließen)

Bibliothek

Netio.lib

IRQL

PASSIVE_LEVEL

Weitere Informationen

ConvertInterfaceAliasToLuid

ConvertInterfaceGuidToLuid

ConvertInterfaceIndexToLuid

ConvertInterfaceLuidToGuid

ConvertInterfaceLuidToIndex

ConvertInterfaceLuidToNameA

ConvertInterfaceLuidToNameW

ConvertInterfaceNameToLuidA

ConvertInterfaceNameToLuidW

NET_LUID