Delen via


De functie SetIpForwardEntry2

Met de functie SetIpForwardEntry2 worden de eigenschappen van een IP-routevermelding op een lokale computer ingesteld.

Syntaxis

NETIOAPI_API SetIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Route
);

Parameters

  • Route [in]
    Een aanwijzer naar een MIB_IPFORWARD_ROW2 structuurvermelding voor een IP-routevermelding. Uw stuurprogramma moet het DestinationPrefix lid van de MIB_IPFORWARD_ROW2 structuur instellen op een geldig IP-doelvoorvoegsel en -gezin, het NextHop- lid van MIB_IPFORWARD_ROW2 instellen op een geldig IP-adres en -gezin en het InterfaceLuid-lid of het InterfaceIndex lid van MIB_IPFORWARD_ROW2.

Retourwaarde

SetIpForwardEntry2 retourneert STATUS_SUCCESS als de functie slaagt.

Als de functie mislukt, retourneert SetIpForwardEntry2 een van de volgende foutcodes:

Retourcode Beschrijving
STATUS_INVALID_PARAMETER

Er is een ongeldige parameter doorgegeven aan de functie. Deze fout wordt geretourneerd als een NULL--aanwijzer wordt doorgegeven in de parameter Route, het DestinationPrefix lid van de MIB_IPFORWARD_ROW2-structuur waarnaar de parameter wijst niet is opgegeven, het NextHop lid van de MIB_IPFORWARD_ROW2-structuur niet is opgegeven. of zowel InterfaceLuid als InterfaceIndex leden van de MIB_IPFORWARD_ROW2-structuur zijn niet opgegeven.

STATUS_NOT_FOUND

Kan de opgegeven interface niet vinden. Deze fout wordt geretourneerd als de functie de netwerkinterface die is opgegeven door de InterfaceLuid- of InterfaceIndex lid van de MIB_IPFORWARD_ROW2-structuur waarnaar de parameter Route verwijst, niet kan vinden.

Overige

Gebruik de functie FormatMessage om de berichttekenreeks voor de geretourneerde fout op te halen.

Opmerkingen

De functie SetIpForwardEntry2 wordt gebruikt om de eigenschappen in te stellen voor een bestaande IP-routevermelding op een lokale computer.

Uw stuurprogramma moet de volgende leden van de MIB_IPFORWARD_ROW2-structuur initialiseren waarnaar de rij parameter verwijst.

  • DestinationPrefix-
    Ingesteld op een geldig IPv4- of IPv6-adresvoorvoegsel en -gezin.

  • NextHop-
    Ingesteld op een geldig IPv4- of IPv6-adres en -gezin.

  • InterfaceLuid of InterfaceIndex
    Deze leden worden gebruikt in de volgorde die eerder wordt vermeld. Dus als InterfaceLuid- is opgegeven, wordt dit lid gebruikt om de interface te bepalen. Als er geen waarde is ingesteld voor het InterfaceLuid lid (de waarde van dit lid is ingesteld op nul), wordt de InterfaceIndex lid naast het bepalen van de interface gebruikt.

De offset voor metrische routegegevens die is opgegeven in het Metrische lid van de MIB_IPFORWARD_ROW2-structuur die Route parameter verwijst, vertegenwoordigt slechts een deel van de volledige routemetriek. De volledige metriek is een combinatie van deze metrische route-offset die is toegevoegd aan de metrische interfacegegevens die zijn opgegeven in de metrische lid van de MIB_IPINTERFACE_ROW structuur van de gekoppelde interface. Een stuurprogramma kan de metrische interface ophalen door de functie GetIpInterfaceEntry aan te roepen.

SetIpForwardEntry2 negeert de Age en Origin leden van de MIB_IPFORWARD_ROW2-structuur waarnaar de parameter Rij verwijst. Deze leden worden ingesteld door de netwerkstack en kunnen niet worden gewijzigd met behulp van de functie SetIpForwardEntry2.

De functie SetIpForwardEntry2 mislukt als de DestinationPrefix- en NextHop leden van de MIB_IPFORWARD_ROW2-structuur die de parameter Route verwijst, niet overeenkomen met een IP-routevermelding op de opgegeven interface.

Eisen

Doelplatform

Universal

Versie

Beschikbaar in Windows Vista en latere versies van de Windows-besturingssystemen.

Rubriek

Netioapi.h (inclusief Netioapi.h)

Bibliotheek

Netio.lib

IRQL

< DISPATCH_LEVEL

Zie ook

CreateIpForwardEntry2-

DeleteIpForwardEntry2

GetBestRoute2-

GetIpForwardEntry2

GetIpForwardTable2-

GetIpInterfaceEntry-

InitializeIpForwardEntry-

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

MIB_IPINTERFACE_ROW

NotifyRouteChange2-