GetBestInterface-Funktion (iphlpapi.h)

Artikel
03/01/2024

Die GetBestInterface-Funktion ruft den Index der Schnittstelle ab, die die beste Route zur angegebenen IPv4-Adresse aufweist.

Syntax

IPHLPAPI_DLL_LINKAGE DWORD GetBestInterface(
  [in]  IPAddr dwDestAddr,
  [out] PDWORD pdwBestIfIndex
);

Parameter

[in] dwDestAddr

Die IPv4-Zieladresse, für die die Schnittstelle abgerufen werden soll, die die beste Route in Form einer IPAddr-Struktur aufweist.

[out] pdwBestIfIndex

Ein Zeiger auf eine DWORD-Variable , die den Index der Schnittstelle empfängt, die die beste Route zur IPv4-Adresse aufweist, die von dwDestAddr angegeben wird.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Rückgabecode	Beschreibung
ERROR_CAN_NOT_COMPLETE	Der Vorgang konnte nicht abgeschlossen werden.
ERROR_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im pdwBestIfIndex-Parameter übergeben wird oder wenn der pdwBestIfIndex auf arbeitsspeicher verweist, der nicht geschrieben werden kann.
ERROR_NOT_SUPPORTED	Die Anforderung wird nicht unterstützt. Dieser Fehler wird zurückgegeben, wenn sich kein IPv4-Stapel auf dem lokalen Computer befindet.
Andere	Verwenden Sie die FormatMessage-Funktion , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Die GetBestInterface-Funktion funktioniert nur mit IPv4-Adressen. Für die Verwendung mit IPv6-Adressen muss GetBestInterfaceEx verwendet werden.

Informationen zum IPAddr-Datentyp finden Sie unter Windows-Datentypen. Verwenden Sie die Funktionen inet_addr und inet_ntoa, um eine IP-Adresse zwischen gepunkteter Dezimalschreibweise und dem IPAddr-Format zu konvertieren.

Unter Windows Vista und höher wird der pdwBestIfIndex-Parameter intern vom IP-Hilfsprogramm als Zeiger auf einen NET_IFINDEX-Datentyp behandelt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	iphlpapi.h
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll