Freigeben über


RtmDeleteRoute-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 RtmDeleteRoute-Funktion löscht einen Routeneintrag.

Syntax

DWORD RtmDeleteRoute(
  _In_  HANDLE ClientHandle,
  _In_  PVOID  Route,
  _Out_ DWORD  Flags,
  _Out_ PVOID  CurBestRoute
);

Parameter

ClientHandle [in]

Handle, das den Client und damit das Routingprotokoll der hinzugefügten oder aktualisierten Route identifiziert. Rufen Sie dieses Handle ab, indem Sie RtmRegisterClient aufrufen.

Route [in]

Zeiger auf eine protokollfamilienspezifische Struktur, die die neue oder aktualisierte Route angibt. Die folgenden Felder werden vom Routingtabellen-Manager verwendet, um die Routingtabelle zu aktualisieren:

Wert Bedeutung
RR_Network
Gibt die Zielnetzwerknummer an.
RR_InterfaceID
Gibt den Index der Schnittstelle an, über die die Route empfangen wurde.
RR_NextHopAddress
Gibt die Netzwerkadresse des Next-Hop-Routers an.

Flags [out]

Zeiger auf eine Reihe von Flags, die den Typ der Änderungsmeldung und die In den bereitgestellten Puffern platzierten Informationen angeben. Dieser Parameter ist einer der folgenden Werte.

Flags Bedeutung
RTM_NO_CHANGE
Das Löschen der Route wirkte sich nicht auf die beste Route zu einem Zielnetzwerk aus. Anders ausgedrückt: Ein anderer Eintrag stellt eine Route zum gleichen Zielnetzwerk dar und weist eine niedrigere Metrik auf.
RTM_ROUTE_DELETED
Die gelöschte Route war die einzige Verfügbare Route für ein bestimmtes Zielnetzwerk.
RTM_ROUTE_CHANGED
Nachdem diese Route gelöscht wurde, wurde eine andere Route zur besten Route zu einem bestimmten Zielnetzwerk. CurBestRoute verweist auf die Informationen für die neue beste Route.

CurBestRoute [out]

Zeiger auf eine Struktur, die ggf. die aktuellen Informationen zur besten Route empfängt. Der Typ der Struktur ist spezifisch für die Protokollfamilie, z. B. IP oder IPX.

Dieser Parameter ist optional. Wenn der Aufrufer NULL für diesen Parameter angibt, werden die aktuellen Informationen zur besten Route nicht zurückgegeben.

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_INVALID_HANDLE
Der Clienthandleparameter ist kein gültiges Handle.
ERROR_INVALID_PARAMETER
Die Routenstruktur, auf die der Parameter Route verweist, enthält einen Memberwert.
ERROR_NO_SUCH_ROUTE
Es gibt keine Einträge in der Routingtabelle, die den Parametern der angegebenen Route entsprechen.
ERROR_NO_SYSTEM_RESOURCES
Es sind nicht genügend Ressourcen vorhanden, um den Vorgang auszuführen.

Bemerkungen

Die Funktion generiert eine Routenänderungsmeldung, wenn sich die beste Route zu einem Zielnetzwerk als Ergebnis des Löschvorgangs geändert hat. Die Route-Change-Nachricht wird jedoch nicht an den Client gesendet, der diesen Aufruf tätigt. Stattdessen werden relevante Informationen von dieser Funktion direkt an diesen Client zurückgegeben.

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

RtmAddRoute

RtmDequeueRouteChangeMessage