ISyncMgrControl::StartItemSync 方法 (syncmgr.h)

启动由特定处理程序管理的指定项的同步。

语法

HRESULT StartItemSync(
  [in] LPCWSTR                    pszHandlerID,
  [in] LPCWSTR                    *ppszItemIDs,
  [in] ULONG                      cItems,
  [in] HWND                       hwndOwner,
  [in] IUnknown                   *punk,
  [in] SYNCMGR_SYNC_CONTROL_FLAGS nSyncControlFlags,
  [in] ISyncMgrSyncResult         *pResult
);

参数

[in] pszHandlerID

类型: LPCWSTR

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

[in] ppszItemIDs

类型: LPCWSTR*

指向缓冲区的指针的地址,该缓冲区包含要同步的项的 ID 数组。 每个 ID 的最大长度MAX_SYNCMGR_ID包括终止 null 字符。 此数组将传递给 Synchronize

[in] cItems

类型:DWORD

ppszItemIDs 中的 ID 数。

[in] hwndOwner

类型:HWND

项可用于显示任何必要 UI 的窗口句柄。 此值可以为 NULL

[in] punk

类型: IUnknown*

指向要传递给 SynchronizeIUnknown 的指针。 此参数可以为 NULL。

[in] nSyncControlFlags

类型: SYNCMGR_SYNC_CONTROL_FLAGS

SYNCMGR_SYNC_CONTROL_FLAGS 枚举的成员,指定在执行排队同步时,是否应再次同步当前同步和排队同步中找到的项。

[in] pResult

类型: ISyncMgrSyncResult*

指向 ISyncMgrSyncResult 实例的指针,其 Result 方法在同步结束时通过成功、失败或取消调用。 使用处理程序同步的聚合状态调用 Result 方法。 此参数可以为 NULL。

返回值

类型: HRESULT

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

注解

此方法类似于 UpdateItems

示例

以下示例演示了处理程序过程使用 ISyncMgrControl::StartItemSync

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))
    {
        // Synchronize one sync item for the sync handler.
        hr = pControl->StartItemSync(s_szMySyncHandlerID,
                                     s_szMySyncHandlerMusicContentID,
                                     1,
                                     _hwnd,
                                     NULL,
                                     NULL);
        pControl->Release();
    }

    ...

}

要求

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