FlushIpNetTable2-Funktion
Die FlushIpNetTable2-Funktion leert die IP-Nachbartabelle auf einem lokalen Computer.
Syntax
NETIOAPI_API FlushIpNetTable2(
_In_ ADDRESS_FAMILY Family,
_In_ NET_IFINDEX InterfaceIndex
);
Parameter
Familie [in]
Die zu leerende Adressfamilie.Mögliche Werte für die Adressfamilie sind in der Winsock2.h-Headerdatei aufgeführt. Beachten Sie, dass die Werte für die AF_ Adressfamilie und PF_ Protokollfamilienkonstanten identisch sind (z. B. AF_INET und PF_INET), sodass Sie beide Konstanten verwenden können.
Unter Windows Vista und höheren Versionen der Windows-Betriebssysteme sind mögliche Werte für den Family-Parameter in der Ws2def.h-Headerdatei definiert. Beachten Sie, dass die Ws2def.h-Headerdatei automatisch in Netioapi.h enthalten ist und Sie Ws2def.h niemals direkt verwenden sollten.
Die folgenden Werte werden derzeit für die Adressfamilie unterstützt:
AF_INET
Die IPv4-Adressfamilie. Wenn dieser Wert angegeben wird, leert diese Funktion die benachbarte IP-Adresstabelle, die nur IPv4-Einträge enthält.AF_INET6
Die IPv6-Adressfamilie. Wenn dieser Wert angegeben wird, leert diese Funktion die benachbarte IP-Adresstabelle, die nur IPv6-Einträge enthält.AF_UNSPEC
Die Adressfamilie ist nicht angegeben. Wenn dieser Wert angegeben wird, leert diese Funktion die benachbarte IP-Adresstabelle, die IPv4- und IPv6-Einträge enthält.
InterfaceIndex [in]
Der Schnittstellenindex. Wenn der Index angegeben ist, leert die Funktion die Benachbarten IP-Adresseinträge auf einer bestimmten Schnittstelle. In der anderen Weise löscht die Funktion die Einträge der benachbarten IP-Adressen auf allen Schnittstellen. Um die Schnittstelle zu ignorieren, legen Sie diesen Parameter auf 0 (null) fest.
Rückgabewert
FlushIpNetTable2 gibt STATUS_SUCCESS zurück, wenn die Funktion erfolgreich ist.
Wenn die Funktion fehlschlägt, gibt FlushIpNetTable2 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 der Family-Parameter nicht als AF_INET, AF_INET6 oder AF_UNSPEC angegeben wurde. |
| 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 AF_INET im Family-Parameter angegeben wurde, oder wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und AF_INET6 im Family-Parameter angegeben wurde. Dieser Fehler wird auch für Versionen von Windows zurückgegeben, bei denen diese Funktion nicht unterstützt wird. |
| Andere | Verwenden Sie die FormatMessage-Funktion , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen. |
Bemerkungen
Die FlushIpNetTable2-Funktion leert oder löscht die benachbarten IP-Adressen auf einem lokalen Computer. Ihr Treiber kann den Family-Parameter verwenden, um das Löschen benachbarter IP-Adressen auf eine bestimmte IP-Adressfamilie zu beschränken. Wenn benachbarte IP-Adressen für IPv4 und IPv6 gelöscht werden sollen, sollte Ihr Treiber den Family-Parameter auf AF_UNSPEC festlegen. Ihr Treiber kann den Parameter InterfaceIndex verwenden, um benachbarte IP-Adressen auf eine bestimmte Schnittstelle zu beschränken. Wenn benachbarte IP-Adressen für alle Schnittstellen gelöscht werden sollen, sollte Ihr Treiber den Parameter InterfaceIndex auf 0 (null) festlegen.
Der Treiber muss den Family-Parameter entweder AF_INET, AF_INET6 oder AF_UNSPEC initialisieren.
Anforderungen
Zielplattform |
Universell |
Version |
Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme. |
Header |
Netioapi.h (netioapi.h einschließen) |
Bibliothek |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |