rtmHoldDestination 函式 (rtmv2.h)
RtmHoldDestination 函式會將目的地標示為在特定時間內處於按住狀態。 只有在刪除任何檢視中目的地的最後一個路由時,才會發生按住狀態。
使用保留狀態的路由通訊協議會繼續公告最後一個路由,直到保留到期為止,即使較新的路由同時到達也一樣。 路由會公告為已刪除的路由。 不過,較新的路由是由路由通訊協議用於轉送用途。 當保留到期時,會公告新的路由。
語法
DWORD RtmHoldDestination(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_DEST_HANDLE DestHandle,
[in] RTM_VIEW_SET TargetViews,
[in] ULONG HoldTime
);
參數
[in] RtmRegHandle
從先前呼叫 RtmRegisterEntity 取得的用戶端句柄。
[in] DestHandle
要標示為保留的目的地句柄。
[in] TargetViews
指定要在其中保存目的地的檢視。
[in] HoldTime
指定保留目的地的長度,以毫秒為單位。
傳回值
如果函式成功,傳回值會NO_ERROR。
如果函式失敗,傳回值就是下列其中一個錯誤碼。
值 | 意義 |
---|---|
|
指定的保留時間是零。 |
|
控制代碼無效。 |
備註
不論指定的 HoldTime 為何,所有處於保留狀態的路由都會保留單一、最大保留時間的所有檢視。
如需使用此函式的範例程式代碼,請參閱 使用路由 Hold-Down 狀態。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 都不支援 |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | rtmv2.h |
程式庫 | Rtm.lib |
Dll | Rtm.dll |