ISyncMgrSyncItemInfo::IsEnabled メソッド (syncmgr.h)

項目が有効かどうかを示す値を生成します。

構文

HRESULT IsEnabled();

戻り値

種類: HRESULT

項目が有効になっている場合は、S_OKを返します。それ以外の場合は、S_FALSE。

アイテムが Sync Center で現在の状態を維持する必要がある場合は、E_NOTIMPLを返すことができます。 他の値が返された場合、Sync Center はアイテムの有効な状態を最後の既知の値に設定し、必要に応じて関連付けられたタスクを有効または無効にします。

GetCapabilities から返されるマスクにSYNCMGR_ICM_QUERY_BEFORE_ENABLEまたはSYNCMGR_ICM_QUERY_BEFORE_DISABLEフラグが設定されている場合、ハンドラーは独自の有効な状態を管理する必要があるため、S_OKまたはS_FALSEを返す必要があります。 その他の戻り値はエラーと見なされます。

注釈

アイテムが無効になっている場合、同期センターによって同期されません。 また、アイテムで使用可能なアクションの多く (同期など) は、UI で削除または無効化されます。

アイテムは、IsEnabled からS_FALSEを返し、GetPolicies 実装でSYNCMR_IPM_PREVENT_ENABLE フラグを設定することで、Disconnected 状態を実装できます。 これにより、アイテムが無効として表示され、ユーザーが手動で有効にできなくなります。

有効な値は、フォルダー UI で System.Sync.Enabled (PKEY_Sync_Enabled) プロパティとして使用できます。

Sync Center は 、UpdateHandler メソッドが呼び出されるたびにこのメソッドを呼び出します。

例

次の例は、プライベート クラス関数を呼び出して有効な状態を取得するこのメソッドの実装を示しています。

STDMETHODIMP CMyDeviceSyncItem::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? S_OK : S_FALSE);
}

要件

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