Udostępnij przez


DeleteIpForwardEntry2, funkcja

Funkcja DeleteIpForwardEntry2 usuwa wpis trasy IP na komputerze lokalnym.

Składnia

NETIOAPI_API DeleteIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Row
);

Parametry

  • wiersza [in]
    Wskaźnik do wpisu struktury MIB_IPFORWARD_ROW2 dla wpisu trasy IP. Po pomyślnym powrocie ten wpis zostanie usunięty.

Wartość zwracana

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

Jeśli funkcja nie powiedzie się, DeleteIpForwardEntry2 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 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 punktów parametrów wiersza, nexthop elementu członkowskiego struktury MIB_IPFORWARD_ROW2 nie określono, lub oba InterfaceLuid i InterfaceIndex składowych struktury MIB_IPFORWARD_ROW2 nie zostały określone.

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, a adres IPv4 został określony w adres elementu członkowskiego MIB_IPFORWARD_ROW2 struktury, do którego wskazuje wiersz lub jeśli żaden stos IPv6 nie znajduje się na komputerze lokalnym, a adres IPv6 został określony w elemencie Adres.

inne

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

Uwagi

Funkcja DeleteIpForwardEntry2 służy do usuwania 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 DeleteIpForwardEntry2 usuwa wpis trasy IP.

Funkcja DeleteIpForwardEntry2 kończy się niepowodzeniem, jeśli DestinationPrefix i NextHop składowych struktury MIB_IPFORWARD_ROW2, że parametr wiersza wskazuje, że nie pasuje do istniejącego wpisu trasy IP w interfejsie określonym w InterfaceLuid lub InterfaceIndex elementów członkowskich.

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

GetBestRoute2

GetIpForwardEntry2

GetIpForwardTable2

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

NotifyRouteChange2

SetIpForwardEntry2