GetIpPathEntry-Funktion
Die GetIpPathEntry-Funktion ruft Informationen für einen IP-Pfadeintrag auf einem lokalen Computer ab.
Syntax
NETIOAPI_API GetIpPathEntry(
_Inout_ PMIB_IPPATH_ROW Row
);
Parameter
- Zeile [ein, ausgehend]
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
GetIpPathEntry gibt STATUS_SUCCESS zurück, wenn die Funktion erfolgreich ist.
Wenn die Funktion fehlschlägt, gibt GetIpPathEntry einen der folgenden Fehlercodes zurück:
| Rückgabecode | Beschreibung |
|---|---|
| STATUS_INVALID_PARAMETER | Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn im Row-Parameter ein NULL-Zeiger übergeben wird, der si_family Member im Destination-Member der MIB_IPPATH_ROW-Struktur, auf die der Row-Parameter verweist, nicht auf AF_INET oder AF_INET6 festgelegt wurde oder die Member InterfaceLuid und InterfaceIndex der MIB_IPPATH_ROW-Struktur nicht angegeben wurden. Dieser Fehler wird auch zurückgegeben, wenn der si_family Member im Quellelement der MIB_IPPATH_ROW-Struktur nicht mit der Ziel-IP-Adressfamilie übereinstimmte und die si_family für die Quell-IP-Adresse nicht als AF_UNSPEC angegeben wurde. |
| STATUS_NOT_FOUND | Die angegebene Schnittstelle konnte nicht gefunden werden. Dieser Fehler wird zurückgegeben, wenn die Funktion die Netzwerkschnittstelle nicht finden kann, die vom InterfaceLuid - oder InterfaceIndex-Member der MIB_IPPATH_ROW Struktur angegeben wird, auf die der Row-Parameter verweist. |
| STATUS_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 in den Quell- und Zielmembern der MIB_IPPATH_ROW-Struktur angegeben wurde, auf die der Row-Parameter verweist, oder wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und eine IPv6-Adresse in den Membern Quelle und Ziel angegeben wurde. |
| Andere | Verwenden Sie die FormatMessage-Funktion , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen. |
Bemerkungen
Die GetIpPathEntry-Funktion wird verwendet, um einen MIB_IPPATH_ROW-Struktureintrag abzurufen.
Bei der Eingabe muss der Treiber die folgenden Member der MIB_IPPATH_ROW Struktur initialisieren, auf die der Row-Parameter verweist.
Ziel
Legen Sie auf eine gültige IPv4- oder IPv6-Adresse und -Familie fest.Quelle
Legen Sie die Adressfamilie, die im Quellmitglied angegeben ist, auf die Ziel-IP-Adressfamilie fest, die im Zielmitglied angegeben ist, oder auf AF_UNSPEC.InterfaceLuid oder InterfaceIndex
Diese Member werden in der zuvor aufgeführten Reihenfolge verwendet. Wenn Also InterfaceLuid angegeben ist, wird dieser Member verwendet, um die Schnittstelle zu bestimmen. Wenn kein Wert für das InterfaceLuid-Element festgelegt wurde (der Wert dieses Members wurde auf 0 festgelegt), wird als Nächstes das InterfaceIndex-Element verwendet, um die Schnittstelle zu bestimmen.
Wenn der Aufruf erfolgreich ist, ruft GetIpPathEntry bei der Ausgabe die anderen Eigenschaften für den IP-Pfadeintrag ab und füllt die MIB_IPPATH_ROW Struktur aus, auf die der Row-Parameter verweist.
Ihr Treiber kann die GetIpPathTable-Funktion aufrufen, um die IP-Pfadeinträge auf einem lokalen Computer aufzulisten.
Anforderungen
Zielplattform |
Universell |
Version |
Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme. |
Header |
Netioapi.h (netioapi.h einschließen) |
Bibliothek |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |