rtmLockRoute 函式 (rtmv2.h)

發行項
03/01/2024

RtmLockRoute 函式會鎖定或解除鎖定路由表中的路由。這可保護路由，而用戶端對用戶端所擁有的不透明路由指標進行必要的變更。

語法

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

參數

[in] RtmRegHandle

從先前呼叫 RtmRegisterEntity 取得的用戶端句柄。

[in] RouteHandle

要鎖定之路由的句柄。

[in] Exclusive

指定在獨佔 (TRUE) 或共用 (FALSE) 模式中鎖定或解除鎖定路由。

[in] LockRoute

指定鎖定或解除鎖定路由。指定 TRUE 以鎖定路由;指定 FALSE 將它解除鎖定。

[out] RoutePointer

如果必須傳回指標：在輸入時， RoutePointer 是 NULL 的指標。在輸出中，如果客戶端擁有路由， RoutePointer 會收到下一個躍點的指標;否則 ，RoutePointer 會保持不變。

如果不需要傳回句柄：在輸入時， RoutePointer 為 NULL。

傳回值

如果函式成功，傳回值會NO_ERROR。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

值	意義
ERROR_ACCESS_DENIED	呼叫用戶端不會擁有此路由。
ERROR_INVALID_HANDLE	控制代碼無效。

備註

在呼叫 RtmLockRoute 且 LockRoute 參數設為 FALSE 或呼叫 RtmUpdateAndUnlockRoute 之前，請勿呼叫任何其他 RTMv2 函式。

目前，此函式會鎖定整個目的地，而不只是路由。

用戶端只能變更RTM_ROUTE_INFO結構的「我的」、PrefInfo、BelongsToViews、EntitySpecificInfo 和 NextHopsList 成員。

如果有任何這些值變更，客戶端必須呼叫 RtmUpdateAndUnlockRoute ，以通知路由表管理員變更。

規格需求

需求	值
最低支援的用戶端	都不支援
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平台	Windows
標頭	rtmv2.h
程式庫	Rtm.lib
Dll	Rtm.dll