RtmDeleteRouteToDest-Funktion (rtmv2.h)

Artikel
08/25/2023

Die RtmDeleteRouteToDest-Funktion löscht eine Route aus der Routingtabelle und aktualisiert die Informationen zur besten Route für das entsprechende Ziel, wenn sich die beste Route geändert hat. Wenn sich die beste Route ändert, wird eine Änderungsbenachrichtigung generiert.

Syntax

DWORD RtmDeleteRouteToDest(
  [in]  RTM_ENTITY_HANDLE       RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE        RouteHandle,
  [out] PRTM_ROUTE_CHANGE_FLAGS ChangeFlags
);

Parameter

[in] RtmRegHandle

Handle mit dem Client, der von einem vorherigen Aufruf von RtmRegisterEntity abgerufen wurde.

[in] RouteHandle

Handle mit der zu löschenden Route.

[out] ChangeFlags

Bei der Eingabe ist ChangeFlags ein Zeiger auf RTM_ROUTE_CHANGE_FLAGS Datentyp.

Bei der Ausgabe erhält ChangeFlags RTM_ROUTE_CHANGE_BEST Flag, wenn die beste Route geändert wurde.

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	Bedeutung
ERROR_ACCESS_DENIED	Der aufrufende Client besitzt diese Route nicht.
ERROR_INVALID_HANDLE	Das Handle ist ungültig.
ERROR_NOT_FOUND	Die angegebene Route wurde nicht gefunden.

Hinweise

Das RouteHandle sollte anschließend nicht von einem Client freigegeben werden, wenn der Client bereits RtmDeleteRouteToDest mit diesem Handle aufgerufen hat. Die RtmDeleteRouteToDest-Funktion löscht die Route und gibt das Handle frei.

Anforderungen


Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	rtmv2.h
Bibliothek	Rtm.lib
DLL	Rtm.dll