if_indextoname-Funktion (netioapi.h)

Artikel
08/25/2023

Die if_indextoname-Funktion konvertiert den lokalen Index für eine Netzwerkschnittstelle in den NAMEN der ANSI-Schnittstelle.

Syntax

IPHLPAPI_DLL_LINKAGE PCHAR NETIOAPI_API_ if_indextoname(
  [in]  NET_IFINDEX InterfaceIndex,
  [out] PCHAR       InterfaceName
);

Parameter

[in] InterfaceIndex

Der lokale Index für eine Netzwerkschnittstelle.

[out] InterfaceName

Ein Zeiger auf einen Puffer, der die NULL-beendete ANSI-Zeichenfolge enthält, die den Schnittstellennamen enthält, wenn die Funktion erfolgreich zurückgegeben wird. Die Länge des Puffers, auf den dieser Parameter verweist, muss gleich oder größer als IF_NAMESIZE sein.

Rückgabewert

Bei Erfolg gibt if_indextoname einen Zeiger auf eine NULL-beendete ANSI-Zeichenfolge zurück, die den Schnittstellennamen enthält. Bei einem Fehler wird ein NULL-Zeiger zurückgegeben.

Hinweise

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

Die if_indextoname-Funktion ordnet einen Schnittstellenindex dem entsprechenden Namen zu. Diese Funktion ist als Teil der grundlegenden Socketerweiterungen für IPv6 konzipiert, wie von der IETF in RFC 2553 beschrieben. Weitere Informationen finden Sie unter http://www.ietf.org/rfc/rfc2553.txt.

Die if_indextoname-Funktion ist für die Portabilität von Anwendungen mit Unix-Umgebungen implementiert, aber die ConvertInterface-Funktionen werden bevorzugt. Die if_indextoname-Funktion kann durch einen Aufruf der ConvertInterfaceIndexToLuid-Funktion ersetzt werden, um einen Schnittstellenindex in einen NET_LUID gefolgt von einem Aufruf von ConvertInterfaceLuidToNameA , um die NET_LUID in den ANSI-Schnittstellennamen zu konvertieren.

Wenn die if_indextoname fehlschlägt und einen NULL-Zeiger zurückgibt, ist es nicht möglich, einen Fehlercode zu ermitteln.

Die Länge des Puffers in Bytes, auf den der Parameter InterfaceName verweist, muss gleich oder größer sein als IF_NAMESIZE, ein Wert, der in der Headerdatei Netioapi.h deklariert ist , NDIS_IF_MAX_STRING_SIZE. Die maximale Länge eines Schnittstellennamens , NDIS_IF_MAX_STRING_SIZE, ohne dass der beendende NULL-Wert in der Headerdatei "Ntddndis.h " deklariert wird. Die NDIS_IF_MAX_STRING_SIZE ist 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 Headerdatei Iphlpapi.h eingeschlossen wird. Die Headerdateien "Ntddndis.h", "Ifdef.h" und "Netioapi.h " sollten nie 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