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 [in, out]
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 | An die Funktion wurde ein ungültiger Parameter übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL- Zeiger im parameter Row übergeben wird, das si_family Element im Destination Member der MIB_IPPATH_ROW Struktur, auf das der Row Parameter verweist, nicht auf AF_INET oder AF_INET6 festgelegt wurde, oder beide InterfaceLuid und InterfaceIndex Member der MIB_IPPATH_ROW Struktur wurden nicht angegeben. Dieser Fehler wird auch zurückgegeben, wenn das si_family Mitglied im Source Member 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 durch das InterfaceLuid- oder InterfaceIndex-Element 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 der Source angegeben wurde, und Ziel- Member der MIB_IPPATH_ROW Struktur, auf die der Row Parameter verweist, oder wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und eine IPv6-Adresse im Source- und Ziel--Member 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-
Auf eine gültige IPv4- oder IPv6-Adresse und -Familie festgelegt.Source-
Legen Sie die Adressfamilie fest, die im Source- Mitglied angegeben ist, auf die Ziel-IP-Adressfamilie, die im Ziel- Mitglied angegeben ist, oder auf AF_UNSPEC.InterfaceLuid oder InterfaceIndex-
Diese Member werden in der Reihenfolge verwendet, die zuvor aufgeführt ist. Wenn also InterfaceLuid- angegeben wird, wird dieses Element verwendet, um die Schnittstelle zu bestimmen. Wenn kein Wert für das InterfaceLuid Member festgelegt wurde (der Wert dieses Elements wurde auf Null festgelegt), wird das InterfaceIndex Member als Nächstes verwendet, um die Schnittstelle zu bestimmen.
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.
Ihr Treiber kann die GetIpPathTable--Funktion aufrufen, um die IP-Pfadeinträge auf einem lokalen Computer auflisten zu können.
Anforderungen
Zielplattform |
universelle |
Version |
Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme. |
Kopfball |
Netioapi.h (include Netioapi.h) |
Bibliothek |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |