SetIpForwardEntry2 függvény

A SetIpForwardEntry2 függvény beállítja egy IP-útválasztási bejegyzés tulajdonságait egy helyi számítógépen.

Szintaxis

NETIOAPI_API SetIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Route
);

Paraméterek

  • Útvonal [in]
    Egy IP-útvonalbejegyzés MIB_IPFORWARD_ROW2 struktúrájának bejegyzésére mutató mutató. Az illesztőprogramnak a DestinationPrefix tagját a MIB_IPFORWARD_ROW2-struktúrában érvényes IP-célelőtagra és -családra kell állítania, a NextHop tag MIB_IPFORWARD_ROW2 ot érvényes IP-címre és családra kell állítania, és meg kell adnia a InterfaceLuid tagot vagy a InterfaceIndex tagját MIB_IPFORWARD_ROW2.

Visszaadott érték

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

Ha a függvény meghiúsul, SetIpForwardEntry2 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 egy NULL mutatót ad át az Útvonal paraméterben, a DestinationPrefix annak a MIB_IPFORWARD_ROW2 struktúrának a tagját, amelynél a Útvonal paraméterpont nincs megadva, a MIB_IPFORWARD_ROW2 NextHop tagja nem lett megadva, vagy InterfaceLuid és InterfaceIndex MIB_IPFORWARD_ROW2 struktúrájának tagjai nem voltak meghatározva.

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 MIB_IPFORWARD_ROW2 struktúra azon tagja által megadott hálózati adaptert, amelyre a Útvonal paraméter mutat.

Egyéb

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

Megjegyzések

A SetIpForwardEntry2 függvény a helyi számítógépen meglévő IP-útvonal bejegyzés tulajdonságainak beállítására szolgál.

Az illesztőprogramnak inicializálnia kell a MIB_IPFORWARD_ROW2 struktúra alábbi 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.

Az útvonalmetrika eltolása, amely a Metrika azon MIB_IPFORWARD_ROW2 struktúrának a tagja, amely Útvonal paraméterpont, a teljes útvonalmetrika csak egy részét jelöli. A teljes metrika a társított felület MIB_IPINTERFACE_ROW struktúrájának MIB_IPINTERFACE_ROW tagjának metrikájában megadott illesztőmetrikához hozzáadott útvonal metrika kombinációja. Az illesztő a GetIpInterfaceEntry függvény meghívásával lekérheti az interfészmetrikát.

SetIpForwardEntry2 figyelmen kívül hagyja a Kor és Forrás azon MIB_IPFORWARD_ROW2 szerkezet tagjait, amelyekre a sor paraméter mutat. Ezeket a tagokat a hálózati verem állítja be, és nem módosítható a SetIpForwardEntry2 függvény használatával.

A SetIpForwardEntry2 függvény meghiúsul, ha a DestinationPrefix és NextHop azon MIB_IPFORWARD_ROW2 struktúra azon tagjait, amelyekre a Útvonal paraméter nem egyezik a megadott felületen található IP-útvonalbejegyzéssel.

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

GetIpForwardEntry2

GetIpForwardTable2

GetIpInterfaceEntry

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

MIB_IPINTERFACE_ROW

NotifyRouteChange2