Udostępnij przez


GetIpForwardEntry2, funkcja

Funkcja GetIpForwardEntry2 pobiera informacje dotyczące wpisu trasy IP na komputerze lokalnym.

Składnia

NETIOAPI_API GetIpForwardEntry2(
  _Inout_ PMIB_IPFORWARD_ROW2 Row
);

Parametry

  • row [in, out]
    Wskaźnik do wpisu struktury MIB_IPFORWARD_ROW2 dla wpisu trasy IP. Po pomyślnym powrocie ta struktura zostanie zaktualizowana o właściwości wpisu trasy IP.

Wartość zwracana

GetIpForwardEntry2 zwraca STATUS_SUCCESS, jeśli funkcja powiedzie się.

Jeśli funkcja nie powiedzie się, GetIpForwardEntry2 zwraca jeden z następujących kodów błędów:

Kod powrotny Opis
STATUS_INVALID_PARAMETER

Do funkcji przekazano nieprawidłowy parametr. Ten błąd jest zwracany, jeśli wystąpi jedna z następujących sytuacji:

  • Wskaźnik null jest przekazywany w parametrze wiersza.

  • Nie określono elementu członkowskiego DestinationPrefix struktury MIB_IPFORWARD_ROW2, do którego nie określono parametru wiersza.

  • Nie określono elementu członkowskiego NextHop struktury MIB_IPFORWARD_ROW2.

  • Nie określono zarówno InterfaceLuid, jak i InterfaceIndex składowych struktury MIB_IPFORWARD_ROW2.

  • Element PreferredLifetime struktury MIB_IPFORWARD_ROW2 jest większy niż element członkowski ValidLifetime.

  • Składowa MIB_IPFORWARD_ROW2 SitePrefixLeng th jest większa niż długość prefiksu określona przez element członkowski DestinationPrefix DestinationPrefix.

STATUS_NOT_FOUND

Nie można odnaleźć określonego interfejsu. Ten błąd jest zwracany, jeśli funkcja nie może odnaleźć interfejsu sieciowego określonego przez InterfaceLuid lub InterfaceIndex elementu członkowskiego struktury MIB_IPFORWARD_ROW2 wskazywanej przez parametr wiersza.

STATUS_NOT_SUPPORTED

Żądanie nie jest obsługiwane. Ten błąd jest zwracany, jeśli na komputerze lokalnym nie znajduje się stos IPv4 i AF_INET został określony w rodzinie adresów w DestinationPrefix elementu członkowskiego MIB_IPFORWARD_ROW2 struktury MIB_IPFORWARD_ROW2, do którego wskazuje wiersz parametr lub jeśli na komputerze lokalnym nie znajduje się żaden stos IPv6 i AF_INET6 został określony dla rodziny adresów w elementu członkowskiego DestinationPrefix.

inne

Użyj funkcji FormatMessage, aby uzyskać ciąg komunikatu dla zwróconego błędu.

Uwagi

Funkcja GetIpForwardEntry2 służy do pobierania wpisu struktury MIB_IPFORWARD_ROW2.

W danych wejściowych sterownik musi zainicjować następujące elementy członkowskie struktury MIB_IPFORWARD_ROW2, do których wskazuje parametr wiersza.

  • DestinationPrefix
    Ustaw prawidłowy prefiks adresu IPv4 lub IPv6 i rodzinę.

  • NextHop
    Ustaw prawidłowy adres IPv4 lub IPv6 i rodzinę.

  • InterfaceLuid lub InterfaceIndex
    Te elementy członkowskie są używane w kolejności wymienionej wcześniej. Dlatego jeśli określono InterfaceLuid, ten element członkowski jest używany do określania interfejsu. Jeśli nie ustawiono wartości elementu członkowskiego InterfaceLuid (wartość tego elementu członkowskiego została ustawiona na zero), element członkowski InterfaceIndex jest następnie używany do określania interfejsu.

Po pomyślnym wywołaniu GetIpForwardEntry2 pobiera inne właściwości wpisu trasy IP i wypełnia strukturę MIB_IPFORWARD_ROW2 wskazującą parametr wiersza.

Przesunięcie metryki trasy określone w elemencie Metric struktury MIB_IPFORWARD_ROW2 wskazuje parametr Row wskazuje tylko część pełnej metryki trasy. Kompletna metryka jest kombinacją tej metryki trasy dodanej do metryki interfejsu określonej w Metryka składowej struktury MIB_IPINTERFACE_ROW skojarzonego interfejsu. Sterownik może pobrać metrykę interfejsu, wywołując funkcję GetIpInterfaceEntry.

Sterownik może wywołać funkcję GetIpForwardTable2 w celu wyliczenia wpisów trasy IP na komputerze lokalnym.

Wymagania

Platforma docelowa

universal

Wersja

Dostępne w systemie Windows Vista i nowszych wersjach systemów operacyjnych Windows.

Nagłówek

Netioapi.h (include Netioapi.h)

Biblioteka

Netio.lib

IRQL

< DISPATCH_LEVEL

Zobacz też

CreateIpForwardEntry2

DeleteIpForwardEntry2

GetBestRoute2

GetIpForwardTable2

GetIpInterfaceEntry

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

MIB_IPINTERFACE_ROW

NotifyRouteChange2

SetIpForwardEntry2