RtmLockRoute-Funktion (rtmv2.h)

Artikel
08/25/2023

Die RtmLockRoute-Funktion sperrt oder entsperrt eine Route in der Routingtabelle. Dadurch wird die Route geschützt, während ein Client die erforderlichen Änderungen an den undurchsichtigen Routenzeigern vornimmt, die dem Client gehören.

Syntax

DWORD RtmLockRoute(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE  RouteHandle,
  [in]  BOOL              Exclusive,
  [in]  BOOL              LockRoute,
  [out] PRTM_ROUTE_INFO   *RoutePointer
);

Parameter

[in] RtmRegHandle

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

[in] RouteHandle

Handle mit der zu sperrenden Route.

[in] Exclusive

Gibt an, ob die Route in einem exklusiven (TRUE) oder freigegebenen Modus (FALSE) gesperrt oder entsperrt werden soll.

[in] LockRoute

Gibt an, ob die Route gesperrt oder entsperrt werden soll. Geben Sie TRUE an, um die Route zu sperren. Geben Sie FALSE an, um sie zu entsperren.

[out] RoutePointer

Wenn ein Zeiger zurückgegeben werden muss: Bei der Eingabe ist RoutePointer ein Zeiger auf NULL. Wenn der Client die Route besitzt, erhält RoutePointer bei der Ausgabe einen Zeiger auf den nächsten Hop. Andernfalls bleibt RoutePointer unverändert.

Wenn ein Handle nicht zurückgegeben werden muss: Bei der Eingabe ist RoutePointerNULL.

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.

Hinweise

Rufen Sie keine anderen RTMv2-Funktionen auf, bis die Route durch einen Aufruf von RtmLockRoute entsperrt und der LockRoute-Parameter auf FALSE oder ein Aufruf von RtmUpdateAndUnlockRoute festgelegt ist.

Derzeit sperrt diese Funktion das gesamte Ziel, nicht nur die Route.

Clients können nur die Elemente Neighbor, PrefInfo, BelongsToViews, EntitySpecificInfo und NextHopsList der RTM_ROUTE_INFO-Struktur ändern.

Wenn einer dieser Werte geändert wird, muss der Client RtmUpdateAndUnlockRoute aufrufen, um den Routingtabellen-Manager über die Änderungen zu benachrichtigen.

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