RtmUpdateAndUnlockRoute 函式 (rtmv2.h)

發行項
03/05/2024

RtmUpdateAndUnlockRoute 函式會更新路由在目的地路由集中的位置，並調整目的地的最佳路由資訊。

此函式會在用戶端鎖定路由後使用，並直接在 (也稱為 就地更新) 。

語法

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
);

參數

[in] RtmRegHandle

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

[in] RouteHandle

要變更之路由的句柄。

[in] TimeToLive

指定路由到期的時間，以毫秒為單位。指定 INFINITE 以防止路由過期。

[in] RouteListHandle

要移至路由的選擇性路由清單句柄。這個參數是選擇性的，而且可以設定為 NULL。

[in] NotifyType

將此參數設定為 NULL。 NotifyType 保留供日後使用。

[in] NotifyHandle

將此參數設定為 NULL。 NotifyHandle 保留供日後使用。

[out] ChangeFlags

如果最佳路由已變更，則會收到RTM_ROUTE_CHANGE_BEST。

傳回值

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

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

值	意義
ERROR_ACCESS_DENIED	呼叫用戶端不會擁有此路由。

備註

呼叫此函式之前，客戶端應該使用 RtmLockRoute 來鎖定路由，以傳迴路由的指標。然後，用戶端可以使用指標來更新路由資訊。最後，客戶端應該呼叫 RtmUpdateAndUnlockRoute。如果函式執行成功，路由就會解除鎖定。如果呼叫失敗，客戶端必須呼叫 RtmLockRoute ，並將 LockRoute 參數設為 FALSE 來解除鎖定路由。

如需使用此函式的範例程式代碼，請參閱使用 RtmUpdateAndUnlockRoute 更新就地路由。

規格需求

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