DeleteIpForwardEntry2-Funktion

Artikel
06/15/2023

Die DeleteIpForwardEntry2-Funktion löscht einen IP-Routeneintrag auf einem lokalen Computer.

Syntax

NETIOAPI_API DeleteIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Row
);

Parameter

Zeile [in]
Ein Zeiger auf einen MIB_IPFORWARD_ROW2 Struktureintrag für einen IP-Routeneintrag. Bei erfolgreicher Rückgabe wird dieser Eintrag gelöscht.

Rückgabewert

DeleteIpForwardEntry2 gibt STATUS_SUCCESS zurück, wenn die Funktion erfolgreich ist.

Wenn die Funktion fehlschlägt, gibt DeleteIpForwardEntry2 einen der folgenden Fehlercodes zurück:

Rückgabecode	Beschreibung
STATUS_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im Row-Parameter übergeben wird, das DestinationPrefix-Element der MIB_IPFORWARD_ROW2-Struktur , auf die der Row-Parameter verweist, nicht angegeben wurde, das NextHop-Element der MIB_IPFORWARD_ROW2-Struktur nicht angegeben wurde oder die Elemente InterfaceLuid und InterfaceIndex der MIB_IPFORWARD_ROW2-Struktur nicht angegeben wurden.
STATUS_NOT_FOUND	Die angegebene Schnittstelle konnte nicht gefunden werden. Dieser Fehler wird zurückgegeben, wenn die Funktion die Netzwerkschnittstelle nicht finden kann, die vom InterfaceLuid - oder InterfaceIndex-Member der MIB_IPFORWARD_ROW2 Struktur angegeben wird, auf die der Row-Parameter verweist.
STATUS_NOT_SUPPORTED	Die Anforderung wird nicht unterstützt. Dieser Fehler wird zurückgegeben, wenn sich kein IPv4-Stapel auf dem lokalen Computer befindet und eine IPv4-Adresse im Adresselement der MIB_IPFORWARD_ROW2-Struktur angegeben wurde, auf die der Row-Parameter verweist, oder wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und eine IPv6-Adresse im Adresselement angegeben wurde.
Andere	Verwenden Sie die FormatMessage-Funktion , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Bemerkungen

Die DeleteIpForwardEntry2-Funktion wird verwendet, um einen MIB_IPFORWARD_ROW2 Struktureintrag zu löschen.

Bei der Eingabe muss Ihr Treiber die folgenden Member der MIB_IPFORWARD_ROW2 Struktur initialisieren, auf die der Row-Parameter verweist.

DestinationPrefix
Legen Sie auf ein gültiges IPv4- oder IPv6-Adresspräfix und eine gültige Familie fest.
NextHop
Legen Sie auf eine gültige IPv4- oder IPv6-Adresse und -Familie fest.
InterfaceLuid oder InterfaceIndex
Diese Member werden in der zuvor aufgeführten Reihenfolge verwendet. Wenn also InterfaceLuid angegeben ist, wird dieses Element verwendet, um die Schnittstelle zu bestimmen. Wenn kein Wert für das InterfaceLuid-Element festgelegt wurde (der Wert dieses Members wurde auf Null festgelegt), wird das InterfaceIndex-Element als nächstes verwendet, um die Schnittstelle zu bestimmen.

Wenn der Aufruf erfolgreich ist, löscht DeleteIpForwardEntry2 bei der Ausgabe den IP-Routeneintrag.

Die DeleteIpForwardEntry2-Funktion schlägt fehl, wenn die Member DestinationPrefix und NextHop der MIB_IPFORWARD_ROW2 Struktur, auf die der Row-Parameter verweist, nicht mit einem vorhandenen IP-Routeneintrag auf der Schnittstelle übereinstimmen, die im InterfaceLuid - oder InterfaceIndex-Member angegeben ist.

Ihr Treiber kann die GetIpForwardTable2-Funktion aufrufen, um die IP-Routeneinträge auf einem lokalen Computer aufzulisten.

Anforderungen

Zielplattform	Universell
Version	Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme.
Header	Netioapi.h (einschließlich Netioapi.h)
Bibliothek	Netio.lib
IRQL	< DISPATCH_LEVEL