ISyncMgrHandlerInfo::IsEnabled 方法 (syncmgr.h)

获取一个值,该值指示是否启用处理程序。

语法

HRESULT IsEnabled();

返回值

类型: HRESULT

如果启用了处理程序,则返回S_OK;否则,S_FALSE。

如果处理程序希望同步中心保持当前状态,它可以返回E_NOTIMPL。 如果返回任何其他值,同步中心会将处理程序的启用状态设置为最后一个已知值,并根据需要启用或禁用关联的任务。

如果在 从 GetCapabilities 返回的掩码中设置了SYNCMGR_HCM_QUERY_BEFORE_ENABLE或SYNCMGR_HCM_QUERY_BEFORE_DISABLE标志,则处理程序必须管理自己的启用状态,因此必须返回S_OK或S_FALSE。 任何其他返回值都将被视为错误。

注解

如果禁用处理程序,则同步中心不会同步它及其任何项。 此外,在同步中心文件夹 UI 中删除或禁用处理程序可用的许多可能操作(例如同步)。

此值在文件夹 UI 中作为 System.Sync.Enabled (PKEY_Sync_Enabled) 属性提供。

每当调用 UpdateHandler 方法时,同步中心将调用此方法。

示例

以下示例演示此方法的实现,该方法调用私有类函数来检索已启用的状态。

STDMETHODIMP CMyDeviceHandler::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? S_OK : S_FALSE);
}

要求

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

另请参阅

启用

ISyncMgrHandlerInfo