Freigeben über


RtmBlockDeleteRoutes-Funktion

[Diese API wurde von der Routing Table Manager Version 2-API abgelöst und ist über Windows Server 2003 hinaus nicht verfügbar. Anwendungen sollten die Api für Routingtabellen-Manager Version 2 verwenden.]

Die RtmBlockDeleteRoutes-Funktion löscht alle Routen in der angegebenen Teilmenge der Routen in der Tabelle.

Syntax

HANDLE RtmBlockDeleteRoutes(
  _In_ HANDLE ClientHandle,
  _In_ DWORD  EnumerationFlags,
  _In_ PVOID  CriteriaRoute
);

Parameter

ClientHandle [in]

Handle, das den Client und damit das Routingprotokoll der zu löschenden Routen identifiziert.

EnumerationFlags [in]

Gibt an, welche Routen aufgelistet werden sollen. Dieser Parameter beschränkt den Satz gelöschter Routen auf eine Teilmenge, die durch die folgenden Flags und die Werte in den entsprechenden Membern der Struktur definiert wird, auf die der CriteriaRoute-Parameter verweist. Die Flags sind identisch mit denen, die in RtmCreateEnumerationHandle verwendet werden, mit der Ausnahme, dass RTM_ONLY_BEST_ROUTES für RtmBlockDeleteRoutes redundant ist. Die Bezeichnung der besten Route wird angepasst, wenn Routen gelöscht werden, sodass die Funktion schließlich alle Routen in der Teilmenge löscht.

CriteriaRoute [in]

Zeiger auf eine protokollfamilienspezifische Routenstruktur ( RTM_IP_ROUTE oder RTM_IPX_ROUTE). Die Memberwerte in dieser Struktur entsprechen den Flags, die vom EnumerationFlags-Parameter angegeben werden.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Wert BESCHREIBUNG
ERROR_NO_ROUTES
Es gibt keine Routen mit den angegebenen Kriterien.
ERROR_INVALID_HANDLE
Der ClientHandle-Parameter ist ungültig.
ERROR_INVALID_PARAMETER
Mindestens einer der Eingabeparameter ist ungültig, z. B. sind die Enumerationsflags ungültig.
ERROR_NO_SYSTEM_RESOURCES
Es gibt nicht genügend Ressourcen, um den Vorgang auszuführen.
ERROR_NOT_ENOUGH_MEMORY
Es ist nicht genügend Arbeitsspeicher vorhanden, um den Vorgang auszuführen.

Bemerkungen

Die Funktion generiert entsprechende Benachrichtigungen für alle registrierten Clients einschließlich des Aufrufers.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client)
Nicht unterstützt
Unterstützte Mindestversion (Server)
Windows 2000 Server [nur Desktop-Apps]
Ende des Supports (Server)
Windows Server 2003
Header
Rtm.h
Bibliothek
Rtm.lib
DLL
Rtm.dll

Siehe auch

Referenz zu Routingtabellen-Manager, Version 1

Routingtabellen-Manager- Version 1-Funktionen

RtmCreateEnumerationHandle

RtmRegisterClient