GetAdapterIndex-Funktion (iphlpapi.h)

Artikel
03/13/2024

Die GetAdapterIndex-Funktion ruft den Index eines Adapters unter Berücksichtigung seines Namens ab.

Syntax

IPHLPAPI_DLL_LINKAGE DWORD GetAdapterIndex(
  [in]      LPWSTR AdapterName,
  [in, out] PULONG IfIndex
);

Parameter

[in] AdapterName

Ein Zeiger auf eine Unicode-Zeichenfolge, die den Namen des Adapters angibt.

[in, out] IfIndex

Ein Zeiger auf eine ULONG-Variable , die auf den Index des Adapters zeigt.

Rückgabewert

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

Wenn die Funktion fehlschlägt, verwenden Sie FormatMessage , um die Meldungszeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Bis ein Adapter vollständig deaktiviert ist, meldet die GetAdapterIndex-Funktion den Adapter als vorhanden. Beispielsweise kann die NotifyAddrChange-Funktion angeben, dass die IP-Adresse eines kürzlich deaktivierten Adapters entfernt wurde, aber GetAdapterIndex meldet weiterhin einen Adapterindex, bis der Vorgang zum Deaktivieren des Adapters abgeschlossen ist.

Wenn ein oder mehrere Adapter im System vorhanden sind, gibt GetAdapterIndex ERROR_DEV_NOT_EXIST zurück, wenn der abgefragte Adapter nicht vorhanden ist. Wenn keine Adapter vorhanden sind, gibt die GetAdapterIndex-Funktion ERROR_NO_DATA zurück.

Der Adapterindex kann sich ändern, wenn ein Adapter deaktiviert und dann aktiviert wird, oder unter anderen Umständen, und er sollte nicht als persistent betrachtet werden.

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