GetIpPathEntry-Funktion (netioapi.h)

Artikel
03/04/2024

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

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpPathEntry(
  [in, out] PMIB_IPPATH_ROW Row
);

Parameter

[in, out] Row

Ein Zeiger auf einen MIB_IPPATH_ROW Struktureintrag für einen IP-Pfadeintrag. Bei erfolgreicher Rückgabe wird diese Struktur mit den Eigenschaften für den IP-Pfadeintrag 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_FILE_NOT_FOUND	Die angegebene Datei wurde nicht gefunden. Dieser Fehler wird zurückgegeben, wenn die netzwerkschnittstellen-LUID oder der Schnittstellenindex, der vom InterfaceLuid - oder InterfaceIndex-Member des MIB_IPPATH_ROW angegeben wird, auf den der Row-Parameter verweist, kein Wert auf dem lokalen Computer ist.
ERROR_INVALID_PARAMETER	Ein Parameter ist falsch. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im Row-Parameter übergeben wird, der si_family Member im Zielelement des MIB_IPPATH_ROW vom Row-Parameter auf AF_INET oderAF_INET6 verweist, oder die Member InterfaceLuid oder InterfaceIndex des MIB_IPPATH_ROW nicht angegeben sind, auf die vom Row-Parameter verwiesen wird. Dieser Fehler wird auch zurückgegeben, wenn das si_family Member im Quellelement des MIB_IPPATH_ROW , auf das vom Parameter Row verwiesen wird, nicht mit der Ziel-IP-Adressfamilie übereinstimmt und der si_family für die Quell-IP-Adresse nicht als AF_UNSPEC angegeben ist.
ERROR_NOT_FOUND	Element wurde nicht gefunden. Dieser Fehler wird zurückgegeben, wenn die Netzwerkschnittstelle, die vom InterfaceLuid - oder InterfaceIndex-Member der MIB_IPPATH_ROW Struktur angegeben wird, auf die der Row-Parameter verweist, nicht mit der IP-Adresse und Adressfamilie übereinstimmt, die im Zielelement in der MIB_IPPATH_ROW-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 eine IPv4-Adresse im Quell- und Zielmember des MIB_IPPATH_ROW angegeben ist, auf den der Row-Parameter verweist. Dieser Fehler wird auch zurückgegeben, wenn sich auf dem lokalen Computer kein IPv6-Stapel befindet und in den Elementen Quelle und Ziel eine IPv6-Adresse angegeben ist.
Andere	Verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

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

Die GetIpPathEntry-Funktion wird verwendet, um einen MIB_IPPATH_ROW Struktureintrag abzurufen.

Bei der Eingabe muss das Zielelement in der MIB_IPPATH_ROW Struktur, auf die der Row-Parameter verweist, für eine gültige IPv4- oder IPv6-Adresse und -Familie initialisiert werden. Die im Quellelement in der MIB_IPPATH_ROW-Struktur angegebene Adressfamilie muss auch entweder mit der Ziel-IP-Adressfamilie übereinstimmen, die im Zielmitglied angegeben ist, oder die Adressfamilie im Quellelement muss als AF_UNSPEC angegeben werden. Darüber hinaus muss mindestens eines der folgenden Elemente in der MIB_IPPATH_ROW-Struktur , die auf den Row-Parameter verweist, initialisiert werden: 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 ist (die Werte dieses Members sind 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 GetIpPathEntry die anderen Eigenschaften für den IP-Pfadeintrag ab und füllt die MIB_IPPATH_ROW Struktur aus, auf die der Row-Parameter verweist.

Die GetIpPathTable-Funktion kann aufgerufen werden, um die IP-Pfadeinträ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

Weitere Informationen