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 |
Library | Rtm.lib |
DLL | Rtm.dll |