ISyncMgrHandlerInfo::IsConnected メソッド (syncmgr.h)

  • [アーティクル]

ハンドラー (通常は何らかの種類の外部デバイス) が接続されているかどうかを示す値を取得します。

構文

HRESULT IsConnected();

戻り値

型: HRESULT

ハンドラーが接続されている場合は、S_OKを返します。それ以外の場合は、S_FALSE。 このメソッドによって返されるエラーは、S_OKとして解釈されます。

注釈

ハンドラーが切断された場合、そのハンドラーもアイテムも同期センターによって同期されません。 また、Sync センター フォルダー UI では、ハンドラーで使用可能なアクション (Sync など) の多くが削除または無効になっています。

この値は、フォルダー UI で System.Sync.Connected (PKEY_Sync_Connected) プロパティとして使用できます。

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

例

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

STDMETHODIMP CMyDeviceHandler::IsConnected()
{
    return (_IsConnected() ? S_OK : S_FALSE);
}

要件

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