GetIpForwardEntry2 függvény

A GetIpForwardEntry2 függvény lekéri a helyi számítógépen található IP-útvonal bejegyzésének adatait.

Szintaxis

NETIOAPI_API GetIpForwardEntry2(
  _Inout_ PMIB_IPFORWARD_ROW2 Row
);

Paraméterek

  • sor [be, ki]
    Egy IP-útvonalbejegyzés MIB_IPFORWARD_ROW2 struktúrájának bejegyzésére mutató mutató. Sikeres visszatérés esetén ez a struktúra frissül az IP-útvonal bejegyzésének tulajdonságaival.

Visszaadott érték

GetIpForwardEntry2 a függvény sikeres működése esetén STATUS_SUCCESS ad vissza.

Ha a függvény meghiúsul, GetIpForwardEntry2 a következő hibakódok egyikét adja vissza:

Kód visszaadása Leírás
STATUS_INVALID_PARAMETER

Érvénytelen paraméter lett átadva a függvénynek. Ez a hiba akkor jelenik meg, ha az alábbi helyzetek valamelyike fordul elő:

  • A Sor paraméterben egy NULL mutatót ad át.

  • A DestinationPrefix annak a MIB_IPFORWARD_ROW2 struktúrának a tagját, amelynek a Sor paramétere nincs megadva.

  • A MIB_IPFORWARD_ROW2 struktúra NextHop-tag nincs megadva.

  • InterfaceLuid és InterfaceIndex MIB_IPFORWARD_ROW2 struktúrájának tagjai nem voltak meghatározva.

  • A MIB_IPFORWARD_ROW2 struktúrájának PreferredLifetime tagja nagyobb, mint ValidLifetime tag.

  • A MIB_IPFORWARD_ROW2 szerkezet SitePrefixLength tagja nagyobb, mint a DestinationPrefix tag által megadott előtaghossz.

STATUS_NOT_FOUND

A megadott felület nem található. Ez a hiba akkor jelenik meg, ha a függvény nem találja a InterfaceLuid vagy InterfaceIndex tagja által megadott hálózati adaptert annak a MIB_IPFORWARD_ROW2 struktúrának, amelyre a Sor paraméter mutat.

STATUS_NOT_SUPPORTED

A kérés nem támogatott. Ez a hiba akkor jelenik meg, ha nem található IPv4-verem a helyi számítógépen, és AF_INET a DestinationPrefix azon MIB_IPFORWARD_ROW2 szerkezet címcsaládjában, amelyre a Sor paraméter mutat, vagy ha nem található IPv6-verem a helyi számítógépen, és AF_INET6 lett megadva a DestinationPrefix tag címcsaládjához.

Egyéb

A FormatMessage függvénnyel szerezze be a visszaadott hiba üzenetsztringét.

Megjegyzések

A GetIpForwardEntry2 függvény egy MIB_IPFORWARD_ROW2 struktúrabejegyzés lekérésére szolgál.

Bemenetkor az illesztőprogramnak inicializálnia kell annak a MIB_IPFORWARD_ROW2 struktúrának a következő tagjait, amelyekre a Sor paraméter mutat.

  • DestinationPrefix
    Állítsa be érvényes IPv4- vagy IPv6-címelőtagra és -családra.

  • NextHop
    Állítsa be érvényes IPv4- vagy IPv6-címre és -családra.

  • InterfaceLuid vagy InterfaceIndex
    Ezeket a tagokat a korábban felsorolt sorrendben használja a rendszer. Ha tehát InterfaceLuid van megadva, ez a tag határozza meg a felületet. Ha a InterfaceLuid taghoz nem állított be értéket (ennek a tagnak az értéke nulla volt), a InterfaceIndex tagot használja a rendszer a felület meghatározásához.

Ha a hívás sikeres, GetIpForwardEntry2 lekéri az IP-útvonalbejegyzés többi tulajdonságát, és kitölti azt a MIB_IPFORWARD_ROW2 struktúrát, amelyre a sor paraméter mutat.

A Metrika azon MIB_IPFORWARD_ROW2 struktúrában megadott útvonalmetrika-eltolás, amelyet a Sor paraméter a teljes útvonalmetrika csak egy részére mutat. A teljes metrika ennek az útvonalmetrikának a kombinációja, amelyet a Metrika a társított felület MIB_IPINTERFACE_ROW struktúrájának tagjaként megadott felületi metrikához adtunk hozzá. Az illesztő a GetIpInterfaceEntry függvény meghívásával lekérheti az interfészmetrikát.

Az illesztőprogram meghívhatja a GetIpForwardTable2 függvényt a helyi számítógépen található IP-útvonal bejegyzéseinek számbavételéhez.

Követelmények

Célplatform

Univerzális

Verzió

Elérhető a Windows Vista és a Windows operációs rendszerek újabb verzióiban.

Fejléc

Netioapi.h (netioapi.h)

Könyvtár

Netio.lib

IRQL

< DISPATCH_LEVEL

Lásd még:

CreateIpForwardEntry2

DeleteIpForwardEntry2

GetBestRoute2

GetIpForwardTable2

GetIpInterfaceEntry

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

MIB_IPINTERFACE_ROW

NotifyRouteChange2

SetIpForwardEntry2