RtmUpdateAndUnlockRoute 函数 (rtmv2.h)

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

将此参数设置为 NULLNotifyType 保留供将来使用。

[in] NotifyHandle

将此参数设置为 NULLNotifyHandle 保留供将来使用。

[out] ChangeFlags

如果更改了最佳路由,则接收RTM_ROUTE_CHANGE_BEST。

返回值

如果函数成功,则返回值NO_ERROR。

如果函数失败,则返回值为以下错误代码之一。

含义
ERROR_ACCESS_DENIED
调用客户端不拥有此路由。

注解

在调用此函数之前,客户端应使用 RtmLockRoute 锁定路由,这将返回指向路由的指针。 然后,客户端可以使用指针更新路由信息。 最后,客户端应调用 RtmUpdateAndUnlockRoute。 如果函数成功执行,则路由将解锁。 如果调用失败,客户端必须通过调用 RtmLockRoute 来解锁路由,并将 LockRoute 参数设置为 FALSE

有关使用此函数的示例代码,请参阅 使用 RtmUpdateAndUnlockRoute 更新就地路由

要求

要求
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 rtmv2.h
Library Rtm.lib
DLL Rtm.dll

另请参阅

RtmAddRouteToDest

RtmDeleteRouteToDest

RtmGetRoutePointer

RtmHoldDestination

RtmLockRoute