GetIpForwardEntry2-Funktion (netioapi.h)

Artikel
08/25/2023

Die GetIpForwardEntry2-Funktion ruft Informationen für einen IP-Routeneintrag auf dem lokalen Computer ab.

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardEntry2(
  [in, out] PMIB_IPFORWARD_ROW2 Row
);

Parameter

[in, out] Row

Ein Zeiger auf einen MIB_IPFORWARD_ROW2 Struktureintrag für einen IP-Routeneintrag. Bei erfolgreicher Rückgabe wird diese Struktur mit den Eigenschaften für den IP-Routeneintrag aktualisiert.

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_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im Row-Parameter übergeben wird, das DestinationPrefix-Element des MIB_IPFORWARD_ROW2 , auf das der Row-Parameter verweist, nicht angegeben wurde, das NextHop-Element des MIB_IPFORWARD_ROW2 , auf das der Row-Parameter verweist, oder die Member InterfaceLuid oder InterfaceIndex des MIB_IPFORWARD_ROW2 , auf das vom Row-Parameter verwiesen wird. Parameter wurden nicht angegeben.
ERROR_NOT_FOUND	Element wurde nicht gefunden. Dieser Fehler wird zurückgegeben, wenn die Netzwerkschnittstelle, die vom InterfaceLuid - oder InterfaceIndex-Member der MIB_IPFORWARD_ROW2 Struktur angegeben wird, auf die der Row-Parameter verweist, nicht mit dem IP-Adresspräfix und der Adressfamilie übereinstimmt, die im DestinationPrefix-Member in der MIB_IPFORWARD_ROW2-Struktur angegeben sind.
ERROR_NOT_SUPPORTED	Die Anforderung wird nicht unterstützt. Dieser Fehler wird zurückgegeben, wenn sich kein IPv4-Stapel auf dem lokalen Computer befindet und AF_INET in der Adressfamilie im DestinationPrefix-Member des MIB_IPFORWARD_ROW2 angegeben wurde, auf den der Row-Parameter verweist. Dieser Fehler wird auch zurückgegeben, wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und AF_INET6 für die Adressfamilie im DestinationPrefix-Element angegeben wurde.
Andere	Verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Die GetIpForwardEntry2-Funktion ist unter Windows Vista und höher definiert.

Die GetIpForwardEntry2-Funktion wird verwendet, um einen MIB_IPFORWARD_ROW2 Struktureintrag abzurufen.

Bei der Eingabe muss das DestinationPrefix-Element in der MIB_IPFORWARD_ROW2 Struktur, auf die der Row-Parameter verweist, mit einem gültigen IPv4- oder IPv6-Adresspräfix und einer gültigen Familie initialisiert werden. Bei der Eingabe muss das NextHop-Element in der MIB_IPFORWARD_ROW2 Struktur, auf die der Row-Parameter verweist, für eine gültige IPv4- oder IPv6-Adresse und -Familie initialisiert werden. Darüber hinaus muss mindestens eines der folgenden Elemente in der MIB_IPFORWARD_ROW2 Struktur initialisiert werden, die auf den Row-Parameter verweist: InterfaceLuid oder InterfaceIndex.

Die Felder werden in der oben aufgeführten Reihenfolge verwendet. Wenn also interfaceLuid angegeben wird, wird dieses Element verwendet, um die Schnittstelle zu bestimmen. Wenn kein Wert für das InterfaceLuid-Element festgelegt wurde (die Werte dieses Members wurden auf Null festgelegt), wird das InterfaceIndex-Element als nächstes verwendet, um die Schnittstelle zu bestimmen.

Bei der Ausgabe, wenn der Aufruf erfolgreich ist, ruft GetIpForwardEntry2 die anderen Eigenschaften für den IP-Routeneintrag ab und füllt die MIB_IPFORWARD_ROW2 Struktur aus, auf die der Row-Parameter verweist.

Der im Metrikelement derMIB_IPFORWARD_ROW2 Struktur angegebene Routenmetrik, auf die vom Row-Parameter verwiesen wird, stellt nur einen Teil der vollständigen Routenmetrik dar. Die vollständige Metrik ist eine Kombination aus dieser Routenmetrik, die der Schnittstellenmetrik hinzugefügt wird, die im Metrikelement der MIB_IPINTERFACE_ROW Struktur der zugeordneten Schnittstelle angegeben ist. Eine Anwendung kann die Schnittstellenmetrik abrufen, indem sie die GetIpInterfaceEntry-Funktion aufruft .

Die GetIpForwardTable2-Funktion kann aufgerufen werden, um die IP-Routeneinträge auf einem lokalen Computer aufzulisten.

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