IVssBackupComponents::Query メソッド (vsbackup.h)

  • [アーティクル]

Query メソッドは、システム上のプロバイダー、または現在のコンテキストに存在するシステム内の完成したシャドウ コピーに対してクエリを実行します。 メソッドは、バックアップ操作中にのみ呼び出すことができます。

構文

HRESULT Query(
  [in]  VSS_ID          QueriedObjectId,
  [in]  VSS_OBJECT_TYPE eQueriedObjectType,
  [in]  VSS_OBJECT_TYPE eReturnedObjectsType,
  [out] IVssEnumObject  **ppEnum
);

パラメーター

[in] QueriedObjectId

予約済み。 このパラメーターの値はGUID_NULLする必要があります。

[in] eQueriedObjectType

指定されたオブジェクト型に対するクエリの制限を示します。 VSS_OBJECT_NONE の値は制限がないことを示します。つまり、すべてのオブジェクトに対してクエリが実行されます。

現在、このパラメーターの値は VSS_OBJECT_NONEする必要があります。

[in] eReturnedObjectsType

返されるオブジェクト型。 このパラメーターの値は 、VSS_OBJECT_SNAPSHOT または VSS_OBJECT_PROVIDERである必要があります。

[out] ppEnum

IVssEnumObject 列挙子オブジェクトへの二重間接ポインター。

戻り値

このメソッドの有効なリターン コードを次に示します。

値 意味
S_OK
 IVssEnumObject インターフェイスのインスタンスへのポインターが正常に返されました。
E_ACCESSDENIED
 呼び出し元が管理者またはバックアップオペレーターではありません。
E_INVALIDARG
 パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
 メモリ不足またはその他のシステム リソース。
VSS_E_BAD_STATE
 バックアップ コンポーネント オブジェクトが初期化されていないか、復元操作中にこのメソッドが呼び出されたか、このメソッドが正しいシーケンス内で呼び出されていません。
VSS_E_OBJECT_NOT_FOUND
 クエリされたオブジェクトが見つかりません。
VSS_E_PROVIDER_VETO
 プロバイダー エラーが予想されます。 プロバイダーは、イベント ログにエラーを記録しました。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。
VSS_E_UNEXPECTED
 予期しないエラー。 エラー コードはエラー ログ ファイルに記録されます。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は、Windows Server 2008 R2 および Windows 7 まではサポートされません。 代わりに、E_UNEXPECTEDが使用されます。
VSS_E_UNEXPECTED_PROVIDER_ERROR
 予期しないプロバイダー エラー。 エラー コードはエラー ログに記録されます。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

注釈

Query は完了したシャドウ コピーに関する情報のみを返すので、公開できるシャドウ コピーの状態はVSS_SS_COMPLETEDのみです。

このメソッドは、バックアップ操作中にのみ呼び出され、その前に IVssBackupComponents::InitializeForBackup および IVssBackupComponents::SetContext の呼び出しが必要です。

Query はシステムで使用可能なすべてのプロバイダーに関する情報を返すことができますが、現在のコンテキスト (IVssBackupComponents::SetContext によって設定) を持つシャドウ コピーに関する情報のみを返します。 たとえば、 _VSS_SNAPSHOT_CONTEXT コンテキストが VSS_CTX_BACKUP に設定されている場合、 クエリ は、VSS_CTX_FILE_SHARE_BACKUPのコンテキストで作成されたシャドウ コピーに関する情報を返しません。

このメソッドは現在、使用可能なすべてのプロバイダーまたはすべての完了したシャドウ コピーの一覧を返しますが、将来的には、特殊化されたクエリ (たとえば、プロバイダーに関連付けられているすべてのシャドウ コピーのクエリ) がサポートされる可能性があります。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー vsbackup.h (VsBackup.h、Vss.h、VsWriter.h を含む)
Library VssApi.lib

こちらもご覧ください

IVssBackupComponents

IVssBackupComponents::InitializeForBackup

IVssBackupComponents::SetContext

IVssEnumObject