RtmUpdateAndUnlockRoute-Funktion (rtmv2.h)

Artikel
03/01/2024

Die RtmUpdateAndUnlockRoute-Funktion aktualisiert die Position der Route im Satz von Routen für ein Ziel und passt die besten Routeninformationen für das Ziel an.

Diese Funktion wird verwendet, nachdem ein Client eine Route gesperrt und direkt aktualisiert hat (auch als direkte Aktualisierung bezeichnet).

Syntax

DWORD RtmUpdateAndUnlockRoute(
  [in]  RTM_ENTITY_HANDLE       RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE        RouteHandle,
  [in]  ULONG                   TimeToLive,
  [in]  RTM_ROUTE_LIST_HANDLE   RouteListHandle,
  [in]  RTM_NOTIFY_FLAGS        NotifyType,
  [in]  RTM_NOTIFY_HANDLE       NotifyHandle,
  [out] PRTM_ROUTE_CHANGE_FLAGS ChangeFlags
);

Parameter

[in] RtmRegHandle

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

[in] RouteHandle

Behandeln Sie die zu ändernde Route.

[in] TimeToLive

Gibt die Zeit in Millisekunden an, nach der die Route abgelaufen ist. Geben Sie INFINITE an, um das Ablaufen von Routen zu verhindern.

[in] RouteListHandle

Handle mit einer optionalen Routenliste, in die die Route verschoben werden soll. Dieser Parameter ist optional und kann auf NULL festgelegt werden.

[in] NotifyType

Legen Sie diesen Parameter auf NULL fest. NotifyType ist für die zukünftige Verwendung reserviert.

[in] NotifyHandle

Legen Sie diesen Parameter auf NULL fest. NotifyHandle ist für die zukünftige Verwendung reserviert.

[out] ChangeFlags

Empfängt RTM_ROUTE_CHANGE_BEST, 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.

Hinweise

Vor dem Aufrufen dieser Funktion sollte der Client die Route mit RtmLockRoute sperren, wodurch ein Zeiger auf die Route zurückgegeben wird. Anschließend kann der Client die Routeninformationen mithilfe des Zeigers aktualisieren. Schließlich sollte der Client RtmUpdateAndUnlockRoute aufrufen. Wenn die Funktion erfolgreich ausgeführt wird, wird die Route entsperrt. Wenn beim Aufruf ein Fehler aufgetreten ist, muss der Client die Route entsperren, indem er RtmLockRoute aufruft, wobei der LockRoute-Parameter auf FALSE festgelegt ist.

Beispielcode mit dieser Funktion finden Sie unter Aktualisieren einer Route An Ort mithilfe von RtmUpdateAndUnlockRoute.

Anforderungen

Anforderung	Wert
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