IVssBackupComponents::P repareForBackup メソッド (vsbackup.h)

[アーティクル]
08/27/2023

PrepareForBackup メソッドを使用すると、VSS によって PrepareForBackup イベントが生成され、ライターは今後のバックアップ操作に備えるシグナルを生成します。これにより、リクエスターのバックアップコンポーネントドキュメントをライターが使用できるようになります。

構文

HRESULT PrepareForBackup(
  [out] IVssAsync **ppAsync
);

パラメーター

[out] ppAsync

非同期操作が完了したタイミングを判断するために使用される IVssAsync インターフェイスのインスタンスへの二重間接ポインター。

戻り値

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

値	意味
S_OK	IVssAsync インターフェイスのインスタンスへのポインターが正常に返されました。 pHrResult パラメーターで返されるエラーコードについては、「IVssAsync::QueryStatus」を参照してください。
E_INVALIDARG	ppAsync は有効なポインターを指していません。つまり、 NULL です。
E_OUTOFMEMORY	呼び出し元がメモリ不足またはその他のシステムリソースです。
VSS_E_BAD_STATE	バックアップコンポーネントオブジェクトが初期化されていないか、復元操作中にこのメソッドが呼び出されたか、このメソッドが正しいシーケンス内で呼び出されていません。
VSS_E_UNEXPECTED	予期しないエラー。エラーコードはエラーログファイルに記録されます。詳細については、「 VSS でのイベントとエラーの処理」を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は、Windows Server 2008 R2 および Windows 7 まではサポートされません。代わりに、E_UNEXPECTEDが使用されます。

注釈

PrepareForBackup は PrepareForBackup イベントを生成します。このイベントは、 CVssWriter::OnPrepareBackup メソッドを介して各ライターの各インスタンスによって処理されます。

PrepareForBackup を呼び出す前に、IVssBackupComponents::SetBackupState を呼び出す必要があります。

Backup Components Document は、 PrepareForBackup イベントハンドラー (CSVsWriter::OnPrepareBackup) 内のライターによって、その後 BackupComplete イベントが生成されるまで変更できます。

呼び出し元は、 IVssAsync インターフェイスを解放する必要があります。

要件

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