ISyncMgrControl

アプリケーションまたはハンドラーが同期を開始または停止したり、ハンドラーやアイテムのセットへの変更を同期センターに通知したり、プロパティ値の変更を通知したりできるメソッドを公開します。

ISyncMgrControl は同期センターによって実装されます。アプリケーションまたはハンドラーは、これを CLSID_SyncMgrControl オブジェクトとしてインスタンス化できます。このオブジェクトは Component Object Model (COM) のローカルサーバーとして実装されています。そのため、ISyncMgrControl メソッドの呼び出しにはかなりの時間がかかる可能性があります。これらの呼び出しは UI スレッドで行うべきではありません。

このインターフェイスのすべてのメソッドは、要求を同期センターにキューイングします。

ISyncMgrControl は ISyncMgrSynchronizeInvoke の代替です。

特定のハンドラーが管理するすべてのアイテムの同期を開始します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

特定のハンドラーが管理する指定されたアイテムの同期を開始します。

型: 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();
    }

    ...

}

すべてのハンドラーが管理するすべてのアイテムを同期します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

このメソッドは UpdateAll に相当します。

例

次の例は、ハンドラーのプロシージャによる ISyncMgrControl::StartSyncAll の使用方法を示しています。

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 all sync items for all sync handlers.
        hr = pControl->StartSyncAll(_hwnd);
        pControl->Release();
    }

    ...

}

指定されたハンドラーの同期を停止します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

特定のハンドラーが管理する指定されたアイテムの同期を停止します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

すべてのハンドラーが管理するすべてのアイテムの同期を停止します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

ハンドラーコレクションを再列挙するよう同期センターに指示するか、ハンドラーコレクション内のハンドラーのプロパティが変更されたことを通知します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

nControlFlags パラメーターに SYNCMGR_CF_WAIT が設定されている場合、UpdateHandlerCollection は、同期センターが指定されたハンドラーコレクションを読み込み、すべてのハンドラーおよびアイテムの情報を再読み込みするまで戻りません。

例

次の例は、ハンドラーのプロシージャによる ISyncMgrControl::UpdateHandlerCollection の使用方法を示しています。

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 a new computer has been added.
        hr = pControl->UpdateHandlerCollection(CLSID_FRSHandlerCollection,
                                               SYNCMGR_CF_NOWAIT);
        pControl->Release();
    }

    ...

}

ハンドラーが管理するアイテムを再列挙するよう同期センターに指示するか、ハンドラーのプロパティが変更されたことを通知します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

nControlFlags パラメーターに SYNCMGR_CF_WAIT が設定されている場合、UpdateHandler は、同期センターが指定されたハンドラーを読み込み、すべてのハンドラーおよびアイテムの情報を再読み込みするまで戻りません。ハンドラーがハンドラーコレクションによって提供されている場合は、ハンドラーを再読み込みするためにハンドラーコレクションも読み込まれます。

例

次の例は、ハンドラーのプロシージャによる ISyncMgrControl::UpdateHandler の使用方法を示しています。

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 on the handler have changed.
        hr = pControl->UpdateHandler(s_szMySyncHandlerID, SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}

同期アイテムのプロパティが変更されたことを同期センターに通知します。

型: 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();
    }

    ...

}

特定のハンドラーまたはアイテムに対してイベントが追加されたことを同期センターに通知します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

nControlFlags パラメーターに SYNCMGR_CF_WAIT が設定されている場合、UpdateEvents は、同期センターが指定されたハンドラーを読み込み、ハンドラーのイベントストアを取得し、そのストアからすべてのイベントを再読み込みするまで戻りません。ハンドラーがハンドラーコレクションによって提供されている場合は、ハンドラーを再読み込みするためにハンドラーコレクションも読み込まれます。

例

次の例は、ハンドラーのプロシージャによる ISyncMgrControl::UpdateEvents の使用方法を示しています。

void CMyDeviceHandler::Synchronize(...)
{
    ...
    // Add events to the event store.

    // 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 we added events to our event store.
        // By passing NULL in pszItemID, we tell Sync Center that the event
        // occurred on the handler rather than a specific item.
        hr = pControl->UpdateEvents(s_szMyDeviceSyncHandlerID, 
                                    NULL,
                                    SYNCMGR_CF_NOWAIT);
        pControl->Release();
    }

    ...

}

特定のハンドラーまたはアイテムに対して競合が追加されたことを同期センターに通知します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

nControlFlags パラメーターに SYNCMGR_CF_WAIT が設定されている場合、UpdateConflicts は、同期センターが指定されたハンドラーを読み込み、ハンドラーの競合ストアを取得し、そのストアからすべての競合を再読み込みするまで戻りません。ハンドラーがハンドラーコレクションによって提供されている場合は、ハンドラーを再読み込みするためにハンドラーコレクションも読み込まれます。

例

次の例は、ハンドラーのプロシージャによる ISyncMgrControl::UpdateEvents の使用方法を示しています。

void CMyDeviceHandler::Synchronize(...)
{
    ...
    // Add conflicts to the event store.

    // 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 we added events to our event store.
        // By passing NULL in pszItemID, we tell Sync Center that the conflict
        // occurred on the handler rather than a specific item.
        hr = pControl->UpdateConflicts(s_szMyDeviceSyncHandlerID, 
                                       NULL,
                                       SYNCMGR_CF_NOWAIT);
        pControl->Release();
    }

    ...

}

ハンドラーをアクティブ化または非アクティブ化します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

アクティブなハンドラーは同期センターフォルダーに表示され、非アクティブなハンドラーは同期セットアップフォルダーに表示されます。

指定されたハンドラーが GetCapabilities メソッドから返されるマスクに SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE または SYNCMGR_HCM_QUERY_BEFORE_DEACTIVATE を返す場合、ハンドラーがアクティブ化または非アクティブ化される前に照会操作が要求されます。照会 UI が要求されない場合、またはユーザーが操作を確認した後、ハンドラーの Activate メソッドが呼び出されます。

nControlFlags パラメーターに SYNCMGR_CF_WAIT が設定されている場合、ActivateHandler は、同期センターがこの通知を処理するまで戻りません。

例

次の例は、ハンドラーのプロシージャによる ISyncMgrControl::ActivateHandler の使用方法を示しています。

void 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 to activate our handler.
        hr = pControl->ActivateHandler(TRUE, 
                                       s_szMySyncHandlerID, 
                                       hwndOwner,
                                       SYNCMGR_CF_NOWAIT);
        pControl->Release();
    }

    ...

}

ハンドラーを有効または無効にします。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

アクティブなハンドラーは同期センターフォルダーに表示され、非アクティブなハンドラーは同期セットアップフォルダーに表示されます。

指定されたハンドラーが GetCapabilities メソッドから返されるマスクに SYNCMGR_HCM_QUERY_BEFORE_ENABLE または SYNCMGR_HCM_QUERY_BEFORE_DISABLE を返す場合、ハンドラーが有効化または無効化される前に確認ダイアログがユーザーに表示されます。照会 UI が要求されない場合、またはユーザーが操作を確認した後、ハンドラーの Enable メソッドが呼び出されます。

nControlFlags パラメーターに SYNCMGR_CF_WAIT が設定されている場合、EnableHandler は、同期センターがこの通知を処理するまで戻りません。

例

次の例は、ハンドラーのプロシージャによる ISyncMgrControl::EnableHandler の使用方法を示しています。

void 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 to enable our handler.
        hr = pControl->EnableHandler(TRUE, 
                                     s_szMySyncHandlerID, 
                                     hwnd,
                                     SYNCMGR_CF_NOWAIT);
        pControl->Release();
    }

    ...

}

指定されたハンドラーが管理する同期アイテムを有効または無効にします。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

有効なアイテムとは、同期可能なアイテムのことです。

指定されたアイテムが GetCapabilities メソッドから返されるマスクに SYNCMGR_ICM_QUERY_BEFORE_ENABLE または SYNCMGR_ICM_QUERY_BEFORE_DISABLE を返す場合、アイテムが有効化または無効化される前に確認ダイアログボックスがユーザーに表示されます。照会 UI が要求されない場合、またはユーザーが操作を確認した後、アイテムの Enable メソッドが呼び出されます。

nControlFlags パラメーターに SYNCMGR_CF_WAIT が設定されている場合、EnableItem は、同期センターがこの通知を処理するまで戻りません。

例

次の例は、ハンドラーのプロシージャによる ISyncMgrControl::EnableHandler の使用方法を示しています。

void 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 to disable the item.
        hr = pControl->EnableItem(FALSE, 
                                  s_szMySyncHandlerID,
                                  s_szMySyncHandlerMusicContentID, 
                                  hwnd,
                                  SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}