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

緩衝區的指標,其中包含管理專案之處理程式的唯一標識碼。 此字串長度上限MAX_SYNCMGR_ID包括終止 Null 字元。

[in] ppszItemIDs

類型: LPCWSTR*

緩衝區指標的位址,其中包含要同步處理之專案的標識元陣列。 每個標識碼的長度上限MAX_SYNCMGR_ID包括終止 Null 字元。 此陣列會傳遞至 Synchronize

[in] cItems

類型: DWORD

ppszItemIDs 中的標識碼數目。

[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