ISyncMgrControl::UpdateItem 方法 (syncmgr.h)

通知同步中心同步项的属性已更改。

语法

HRESULT UpdateItem(
  [in] LPCWSTR               pszHandlerID,
  [in] LPCWSTR               pszItemID,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

参数

[in] pszHandlerID

类型: LPCWSTR

指向缓冲区的指针,该缓冲区包含管理项的处理程序的唯一 ID。 此字符串的最大长度MAX_SYNCMGR_ID包括终止 null 字符。

[in] pszItemID

类型: LPCWSTR

指向包含项的唯一 ID 的缓冲区的指针。 此字符串的最大长度MAX_SYNCMGR_ID包括终止 null 字符。

[in] nControlFlags

类型: SYNCMGR_CONTROL_FLAGS

SYNCMGR_CONTROL_FLAGS枚举中的值,该值指定是应以同步方式还是异步执行更新。

返回值

类型: HRESULT

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

注解

如果在 nControlFlags 参数中设置了SYNCMGR_CF_WAIT,则在同步中心加载指定的处理程序并重新加载所有处理程序和项信息之前, UpdateItem 不会返回。 如果处理程序由处理程序集合提供,则还会加载处理程序集合以重新加载处理程序。

示例

以下示例演示了处理程序过程对 ISyncMgrControl::UpdateItem 的用法。

void CMyDeviceHandler::MiscProc(...)
{
    ...

    // Get the Sync Center control object.
    ISyncMgrControl *pControl = NULL;
    
    hr = CoCreateInstance(CLSID_SyncMgrControl, 
                          CLSCTX_SERVER, 
                          IID_PPV_ARGS(&pControl));
    if (SUCCEEDED(hr))
    {
        // Tell Sync Center that properties of the item have changed.
        hr = pControl->UpdateItem(s_szMySyncHandlerID,
                                  s_szMySyncHandlerMusicContentID,
                                  SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}

要求

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