ISyncMgrHandler::Enable メソッド (syncmgr.h)

アクティブなハンドラーを有効または無効にすることを要求します。 有効なハンドラーは同期でき、無効なハンドラーは同期できません。

構文

HRESULT Enable(
  [in] BOOL fEnable
);

パラメーター

[in] fEnable

種類: BOOL

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

戻り値

型: HRESULT

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

解説

ハンドラーが Sync Center フォルダーに表示されるときに、ハンドラーのショートカット メニューに [有効] エントリと [無効] エントリが表示されるように、SYNCMGR_HCM_CAN_ENABLEフラグとSYNCMGR_HCM_CAN_DISABLE フラグを設定する必要があります。 ハンドラーを有効にすることを選択すると、同期できることを意味します。ハンドラーを無効にすることを選択すると、それができないことを意味します。

Sync Center は、次の 2 つのインスタンスでこのメソッドを呼び出します。

• ユーザーが Sync Center フォルダー内のハンドラーを選択し、 その [有効化] タスクを起動するとします。 ハンドラーが SYNCMGR_OBJECTID_QueryBeforeEnable オブジェクトをサポートしている場合、このメソッドは UI 操作が成功した場合にのみ呼び出されます。
• ユーザーが Sync Center フォルダー内のハンドラーを選択し、その Disable タスクを起動するとします。 ハンドラーが SYNCMGR_OBJECTID_QueryBeforeDisable オブジェクトをサポートしている場合、このメソッドは UI 操作が成功した場合にのみ呼び出されます。

ハンドラーがアクティブ化されたときにアクションを実行する必要がない場合は、次の例に示すように、S_OKまたはE_NOTIMPLのいずれかを返すことができます。

例

次の例は、このメソッドの簡単な実装を示しています。

STDMETHODIMP CMyDeviceHandler::Enable(__in BOOL fEnable)
{
    return E_NOTIMPL;
}

要件

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

関連項目

ISyncMgrHandler

ISyncMgrHandler::GetObject

IsEnabled