GetIpForwardEntry2 – funkce

Funkce GetIpForwardEntry2 načte informace o položce trasy PROTOKOLU IP v místním počítači.

Syntax

NETIOAPI_API GetIpForwardEntry2(
  _Inout_ PMIB_IPFORWARD_ROW2 Row
);

Parametry

• řádek [in, out]
  Ukazatel na položku MIB_IPFORWARD_ROW2 struktury pro položku trasy IP. Při úspěšném vrácení se tato struktura aktualizuje o vlastnosti pro položku trasy PROTOKOLU IP.

Návratová hodnota

GetIpForwardEntry2 vrátí STATUS_SUCCESS, pokud bude funkce úspěšná.

Pokud funkce selže, GetIpForwardEntry2 vrátí jeden z následujících kódů chyb:

Návratový kód	Popis
STATUS_INVALID_PARAMETER	Funkci byla předána neplatná hodnota parametru. Tato chyba se vrátí, pokud dojde k některé z následujících situací: Ukazatel null je předán v parametru řádku řádku. DestinationPrefix člen struktury MIB_IPFORWARD_ROW2, na kterou řádek odkazuje, nebyl zadán. Nebyl zadán člen struktury MIB_IPFORWARD_ROW2 NextHop. InterfaceLuid i InterfaceIndex členy struktury MIB_IPFORWARD_ROW2 nebyly zadány. PreferredLifetime člen struktury MIB_IPFORWARD_ROW2 je větší než člen ValidLifetime. SitePrefixLength člen struktury MIB_IPFORWARD_ROW2 je větší než délka předpony určená DestinationPrefix člen.
STATUS_NOT_FOUND	Zadané rozhraní nebylo nalezeno. Tato chyba se vrátí, pokud funkce nemůže najít síťové rozhraní určené InterfaceLuid nebo InterfaceIndex člen struktury MIB_IPFORWARD_ROW2, na kterou odkazuje řádek parametru.
STATUS_NOT_SUPPORTED	Požadavek není podporován. Tato chyba se vrátí, pokud v místním počítači není umístěn žádný zásobník IPv4 a AF_INET byl zadán v rodině adres v DestinationPrefix člen struktury MIB_IPFORWARD_ROW2, na kterou odkazuje parametr řádek, nebo pokud se v místním počítači nenachází žádný zásobník IPv6 a AF_INET6 nebyl zadán pro řadu adres v DestinationPrefix člen.
Jiné	Pomocí funkce FormatMessage získejte řetězec zprávy pro vrácenou chybu.

Poznámky

Funkce GetIpForwardEntry2 slouží k načtení položky struktury MIB_IPFORWARD_ROW2.

Při vstupu musí ovladač inicializovat následující členy MIB_IPFORWARD_ROW2 struktury, na kterou odkazuje řádek parametru.

• DestinationPrefix
  Nastavte platnou předponu adresy IPv4 nebo IPv6 a rodinu.

• nextHop
  Nastavte platnou adresu IPv4 nebo IPv6 a rodinu.

• InterfaceLuid nebo InterfaceIndex
  Tito členové se používají v pořadí, které je uvedeno dříve. Pokud je tedy zadán InterfaceLuid, použije se tento člen k určení rozhraní. Pokud nebyla nastavena žádná hodnota pro InterfaceLuid člen (hodnota tohoto členu byla nastavena na nulu), InterfaceIndex člen se použije k určení rozhraní.

Pokud je volání úspěšné, GetIpForwardEntry2 načte další vlastnosti pro položku trasy PROTOKOLU IP a vyplní MIB_IPFORWARD_ROW2 strukturu, na kterou odkazuje parametr řádek.

Posun metriky trasy zadaný v metriky člen struktury MIB_IPFORWARD_ROW2, kterou parametr řádek odkazuje, představuje pouze část celé metriky trasy. Úplná metrika je kombinací této metriky trasy přidané do metriky rozhraní zadané v metriky člen MIB_IPINTERFACE_ROW struktury přidruženého rozhraní. Ovladač může načíst metriku rozhraní voláním funkce GetIpInterfaceEntry.

Ovladač může volat funkci GetIpForwardTable2 k vytvoření výčtu položek směrování PROTOKOLU IP na místním počítači.

Požadavky

Cílová platforma	univerzální
Verze	K dispozici v systémech Windows Vista a novějších verzích operačních systémů Windows.
Záhlaví	Netioapi.h (včetně Netioapi.h)
Knihovna	Netio.lib
IRQL	< DISPATCH_LEVEL

Viz také

CreateIpForwardEntry2

DeleteIpForwardEntry2

GetBestRoute2

GetIpForwardTable2

GetIpInterfaceEntry

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

MIB_IPINTERFACE_ROW

NotifyRouteChange2

SetIpForwardEntry2