Freigeben über


FlushIpPathTable-Funktion

Die FlushIpPathTable-Funktion leert die IP-Pfadtabelle auf einem lokalen Computer.

Syntax

NETIOAPI_API FlushIpPathTable(
  _In_ ADDRESS_FAMILY Family
);

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 IP-Pfadtabelle, die nur IPv4-Einträge enthält.

    • AF_INET6
      Die IPv6-Adressfamilie. Wenn dieser Wert angegeben wird, leert diese Funktion die IP-Pfadtabelle, 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.

Rückgabewert

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

Wenn die Funktion fehlschlägt, gibt FlushIpPathTable 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 FlushIpPathTable-Funktion leert oder löscht die IP-Pfadeinträge auf einem lokalen Computer. Ihr Treiber kann den Family-Parameter verwenden, um die zu löschenden IP-Pfadeinträge auf eine bestimmte IP-Adressfamilie zu beschränken. Wenn IP-Pfadeinträge für IPv4 und IPv6 gelöscht werden sollen, sollte Ihr Treiber den Family-Parameter auf AF_UNSPEC 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

Weitere Informationen

GetIpPathEntry

GetIpPathTable

MIB_IPPATH_ROW

MIB_IPPATH_TABLE