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

GetSnapshotProperties メソッドは、指定されたシャドウ コピーのプロパティを取得します。

構文

HRESULT GetSnapshotProperties(
  [in]  VSS_ID            SnapshotId,
  [out] VSS_SNAPSHOT_PROP *pProp
);

パラメーター

[in] SnapshotId

IVssBackupComponents::AddToSnapshotSet によって返されるボリュームのシャドウ コピーの識別子。

[out] pProp

シャドウ コピー のプロパティを受け取る呼び出し元によって割り当てられた VSS_SNAPSHOT_PROP 構造体のアドレス。 ソフトウェア プロバイダーは、この構造体のメンバーを設定する役割を担います。 ソフトウェア プロバイダーは、 構造体に設定するすべての文字列メンバーにメモリを割り当てます。 構造体が不要になった場合、ソフトウェア プロバイダーは VssFreeSnapshotProperties 関数を呼び出してこれらの文字列を解放します。

戻り値

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

説明
S_OK
シャドウ コピーのプロパティが正常に返されました。
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 でのイベントとエラーの処理」を参照してください。

解説

呼び出し元は、GetSnapshotProperties メソッドを呼び出す前に、VSS_SNAPSHOT_PROP構造体の内容を 0 に設定する必要があります。

プロバイダーは、 VSS_SNAPSHOT_PROP 構造体内の文字列の割り当てと解放を担当します。

要件

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

関連項目

IVssBackupComponents

IVssBackupComponents::AddToSnapshotSet

IVssBackupComponents::StartSnapshotSet

VSS_ID

VSS_SNAPSHOT_PROP

VssFreeSnapshotProperties