GetIpForwardTable2 függvény

A GetIpForwardTable2 függvény lekéri az IP-útvonal bejegyzéseit egy helyi számítógépen.

Szintaxis

NETIOAPI_API GetIpForwardTable2(
  _In_  ADDRESS_FAMILY        Family,
  _Out_ PMIB_IPFORWARD_TABLE2 *Table
);

Paraméterek

  • Családi [in]
    A lekérendő címcsalád.

    A címcsalád lehetséges értékei a Winsock2.h fejlécfájlban jelennek meg. Vegye figyelembe, hogy a AF_ címcsalád és PF_ protokollcsalád állandói azonosak (például AF_INET és PF_INET), így bármelyik állandót használhatja.

    A Windows Vista és a Windows operációs rendszerek újabb verzióiban a Family paraméter lehetséges értékei a Ws2def.h fejlécfájlban vannak definiálva. Vegye figyelembe, hogy a Ws2def.h fejlécfájl automatikusan szerepel a Netioapi.h-ban, és soha ne használja közvetlenül a Ws2def.h fájlt.

    A címcsalád esetében jelenleg a következő értékek támogatottak:

    • AF_INET
      Az IPv4-címcsalád. Ha ez az érték meg van adva, ez a függvény azt az IP-útválasztási táblát adja vissza, amely csak IPv4-bejegyzéseket tartalmaz.

    • AF_INET6
      Az IPv6-címcsalád. Ha ez az érték meg van adva, ez a függvény azt az IP-útválasztási táblát adja vissza, amely csak IPv6-bejegyzéseket tartalmaz.

    • AF_UNSPEC
      A címcsalád nincs meghatározva. Ha ez az érték meg van adva, ez a függvény az IPv4- és IPv6-bejegyzéseket tartalmazó IP-útválasztási táblát adja vissza.

  • tábla [ki]
    Mutató egy MIB_IPFORWARD_TABLE2 struktúrára, amely a helyi számítógépen található IP-útvonalbejegyzések táblázatát tartalmazza.

Visszaadott érték

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

Ha a függvény meghiúsul, GetIpForwardTable2 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 NULL mutatót ad át a Tábla paraméterben, vagy a Családi paraméter nincs megadva AF_INET, AF_INET6 vagy AF_UNSPEC.

STATUS_NOT_ENOUGH_MEMORY

A művelet végrehajtásához nincs elegendő memóriaerőforrás.

STATUS_NOT_FOUND

A Családi paraméterben megadott IP-útvonalbejegyzések nem találhatók.

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 Családi paraméterben van megadva, vagy ha nem található IPv6-verem a helyi számítógépen, és AF_INET6 a Családi paraméterben van megadva. Ez a hiba a Windows azon verzióiban is megjelenik, ahol ez a függvény nem támogatott.

Egyéb

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

Megjegyzések

A GetIpForwardTable2 függvény számba adja a helyi számítógépen található IP-útvonal bejegyzéseit, és ezt az információt egy MIB_IPFORWARD_TABLE2 struktúrában adja vissza.

Az IP-útvonal bejegyzései egy MIB_IPFORWARD_TABLE2 struktúrában jelennek meg abban a pufferben, amelyre a tábla paraméter mutat. A MIB_IPFORWARD_TABLE2 struktúra ip-útvonalbejegyzések számát és MIB_IPFORWARD_ROW2 struktúrákat tartalmazó tömböt tartalmaz az egyes IP-útvonalak bejegyzéseihez. Ha ezekre a visszaadott struktúrákra már nincs szükség, az illesztőprogramnak szabadíthatja fel a memóriát FreeMibTablemeghívásával.

Az illesztőprogramnak inicializálnia kell a Családi paramétert AF_INET, AF_INET6 vagy AF_UNSPEC.

Vegye figyelembe, hogy a visszaadott MIB_IPFORWARD_TABLE2 struktúra, amelyet a Tábla paraméter mutat, tartalmazhat a NumEntries tag és a Tábla MIB_IPFORWARD_TABLE2 tag első MIB_IPFORWARD_ROW2 tömbbejegyzése közötti igazításhoz. Előfordulhat, hogy a MIB_IPFORWARD_ROW2 tömbbejegyzések között is van párnázás az igazításhoz. Egy MIB_IPFORWARD_ROW2 tömbbejegyzéshez való hozzáférés feltételezi, hogy létezik párnázás.

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

FreeMibTable

GetBestRoute2

GetIpForwardEntry2

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

NotifyRouteChange2

SetIpForwardEntry2