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

指定したハンドラーによって管理される同期項目を有効または無効にします。

構文

HRESULT EnableItem(
  [in] BOOL                  fEnable,
  [in] LPCWSTR               pszHandlerID,
  [in] LPCWSTR               pszItemID,
  [in] HWND                  hwndOwner,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

パラメーター

[in] fEnable

種類: BOOL

有効にする場合は TRUE 。 無効にする場合は FALSE 。

[in] pszHandlerID

種類: LPCWSTR

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

[in] pszItemID

種類: LPCWSTR

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

[in] hwndOwner

型: HWND

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

[in] nControlFlags

種類: SYNCMGR_CONTROL_FLAGS

項目の有効化または無効化を同期的または非同期的に実行するかどうかを指定する、 SYNCMGR_CONTROL_FLAGS 列挙の値。

戻り値

種類: HRESULT

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

注釈

有効な項目は、同期できる項目です。

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

SYNCMGR_CF_WAITが nControlFlags パラメーターに設定されている場合、同期センターがこの通知を処理するまで 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();
    }

    ...

}

要件