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 を含むバッファーへのポインター。 この文字列は、終端の null 文字を含む最大長MAX_SYNCMGR_IDです。

[in] ppszItemIDs

種類: LPCWSTR*

同期する項目の ID の配列を含むバッファーへのポインターのアドレス。 各 ID は、終端の null 文字を含む最大長MAX_SYNCMGR_IDです。 この配列は Synchronize に渡されます。

[in] cItems

型: DWORD

ppszItemIDs 内の ID の数。

[in] hwndOwner

型: HWND

必要な UI を表示するために項目が使用できるウィンドウへのハンドル。 この値は NULL にすることができます。

[in] punk

種類: IUnknown*

Synchronize に渡される IUnknown へのポインター。 このパラメーターは、NULL でもかまいません。

[in] nSyncControlFlags

種類: SYNCMGR_SYNC_CONTROL_FLAGS

現在の同期とキュー同期の両方で見つかった項目を、キュー同期の実行時に再び同期するかどうかを指定するSYNCMGR_SYNC_CONTROL_FLAGS列挙体のメンバー。

[in] pResult

種類: ISyncMgrSyncResult*

同期の終了時に Result メソッドが呼び出される ISyncMgrSyncResult のインスタンスへのポインター 。成功、失敗、または取り消しのいずれかによって呼び出されます。 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();
    }

    ...

}

要件