ISyncMgrHandler::Enable 方法 (syncmgr.h)

请求启用或禁用 活动 处理程序。 可以同步已启用的处理程序,但禁用的处理程序不能同步。

语法

HRESULT Enable(
  [in] BOOL fEnable
);

参数

[in] fEnable

类型: BOOL

如果为 TRUE ,则启用; 禁用,则为 FALSE。

返回值

类型: HRESULT

如果该方法成功,则返回 S_OK。 否则,将返回 HRESULT 错误代码。

注解

处理程序必须设置“启用”和“禁用”条目的SYNCMGR_HCM_CAN_ENABLE和SYNCMGR_HCM_CAN_DISABLE标志,以便在处理程序显示在“同步中心”文件夹中时显示在处理程序的快捷菜单上。 选择启用处理程序意味着它可以同步;选择禁用处理程序意味着它不能。

同步中心在以下两个实例中调用此方法。

  • 当用户选择“同步中心”文件夹中的处理程序并启动其 “启用” 任务时。 如果处理程序支持 SYNCMGR_OBJECTID_QueryBeforeEnable 对象,则仅在 UI 操作成功时调用此方法。
  • 当用户选择“同步中心”文件夹中的处理程序并启动其 “禁用” 任务时。 如果处理程序支持 SYNCMGR_OBJECTID_QueryBeforeDisable 对象,则仅在 UI 操作成功时调用此方法。
如果处理程序在激活时不需要执行任何操作,它可以返回S_OK或E_NOTIMPL,如以下示例所示。

示例

以下示例演示此方法的简单实现。

STDMETHODIMP CMyDeviceHandler::Enable(__in BOOL fEnable)
{
    return E_NOTIMPL;
}

要求

   
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 syncmgr.h

另请参阅

ISyncMgrHandler

ISyncMgrHandler::GetObject

IsEnabled