ISyncMgrControl::UpdateHandler メソッド (syncmgr.h)

ハンドラーによって管理されている項目を再び再開するように同期センターに指示するか、ハンドラーのプロパティが変更されたことを通知します。

構文

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

パラメーター

[in] pszHandlerID

種類: LPCWSTR

ハンドラーの一意の ID を含むバッファーへのポインター。 この文字列は、終端の null 文字を含む最大長MAX_SYNCMGR_IDです。

[in] nControlFlags

種類: SYNCMGR_CONTROL_FLAGS

更新を同期的に実行するか非同期的に実行するかを指定する、 SYNCMGR_CONTROL_FLAGS 列挙の値。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

SYNCMGR_CF_WAITが nControlFlags パラメーターに設定されている場合、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();
    }

    ...

}

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	syncmgr.h