Dela via


Funktionen GetIpPathEntry

Funktionen GetIpPathEntry hämtar information om en IP-sökvägspost på en lokal dator.

Syntax

NETIOAPI_API GetIpPathEntry(
  _Inout_ PMIB_IPPATH_ROW Row
);

Parametrar

  • Rad [in, ut]
    En pekare till en MIB_IPPATH_ROW strukturpost för en IP-sökvägspost. Vid lyckad retur uppdateras den här strukturen med egenskaperna för POSTEN IP-sökväg.

Returvärde

GetIpPathEntry returnerar STATUS_SUCCESS om funktionen lyckas.

Om funktionen misslyckas returnerar GetIpPathEntry någon av följande felkoder:

Returnera kod Beskrivning
STATUS_INVALID_PARAMETER

En ogiltig parameter skickades till funktionen. Det här felet returneras om en NULL- pekare skickas i parametern Rad, si_family-medlemmen i Destination medlem i den MIB_IPPATH_ROW struktur som rad parameterpunkter till inte har angetts till AF_INET eller AF_INET6. eller både InterfaceLuid och InterfaceIndex medlemmar i MIB_IPPATH_ROW strukturen var ospecificerade. Det här felet returneras också om den si_family medlemmen i Source medlem i MIB_IPPATH_ROW-strukturen inte matchade mål-IP-adressfamiljen och si_family för käll-IP-adressen inte angavs som AF_UNSPEC.

STATUS_NOT_FOUND

Det gick inte att hitta det angivna gränssnittet. Det här felet returneras om funktionen inte kan hitta det nätverksgränssnitt som anges av InterfaceLuid eller InterfaceIndex medlem i den MIB_IPPATH_ROW struktur som rad parameter pekar på.

STATUS_NOT_SUPPORTED

Begäran stöds inte. Det här felet returneras om ingen IPv4-stack finns på den lokala datorn och en IPv4-adress angavs i Source och Destination medlemmar i den MIB_IPPATH_ROW struktur som rad parametern pekar på, eller om ingen IPv6-stack finns på den lokala datorn och en IPv6-adress angavs i Source och Destination medlemmar.

Andra

Använd funktionen FormatMessage för att hämta meddelandesträngen för det returnerade felet.

Anmärkningar

Funktionen GetIpPathEntry används för att hämta en MIB_IPPATH_ROW strukturpost.

Vid indata måste drivrutinen initiera följande medlemmar i den MIB_IPPATH_ROW struktur som rad parametern pekar på.

  • mål
    Ange en giltig IPv4- eller IPv6-adress och -familj.

  • Källa
    Ange den adressfamilj som anges i Source-medlemmen till mål-IP-adressfamiljen som anges i Destination-medlemmen eller till AF_UNSPEC.

  • InterfaceLuid eller InterfaceIndex
    Dessa medlemmar används i den ordning som anges tidigare. Så om InterfaceLuid anges används den här medlemmen för att fastställa gränssnittet. Om inget värde har angetts för InterfaceLuid medlem (värdet för den här medlemmen har angetts till noll) används InterfaceIndex medlem för att fastställa gränssnittet.

När anropet lyckas hämtar GetIpPathEntry de andra egenskaperna för POSTEN IP-sökväg och fyller i den MIB_IPPATH_ROW struktur som rad parameter pekar på.

Drivrutinen kan anropa funktionen GetIpPathTable för att räkna upp IP-sökvägsposterna på en lokal dator.

Krav

Målplattform

Universell

Version

Finns i Windows Vista och senare versioner av Windows-operativsystemen.

Rubrik

Netioapi.h (inkludera Netioapi.h)

Bibliotek

Netio.lib

IRQL

< DISPATCH_LEVEL

Se även

FlushIpPathTable

GetIpPathTable

MIB_IPPATH_ROW

MIB_IPPATH_TABLE