CVssWriter::OnPreRestore メソッド (vswriter.h)

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

OnPreRestore メソッドは、PreRestore イベントの後にライターによって呼び出されます。このメソッドは、復元をサポートする状態 (たとえば、データベースサービスをオフラインにする) にライターを配置し、ファイルを復元するリクエスターのバックアップコンポーネントドキュメントで変更を行うために使用されます (元の復元方法をオーバーライドするように復元ターゲットを設定するなど)。

OnPreRestore は仮想メソッドです。これは CSVsWriter 基底クラスによって実装されますが、派生クラスによってオーバーライドできます。

構文

bool OnPreRestore(
  [in] IVssWriterComponents *pComponent
);

パラメーター

[in] pComponent

リクエスターのバックアップコンポーネントドキュメントの現在のライターに関連付けられているコンポーネントを含む IVssWriterComponents オブジェクトのインスタンス化へのポインター。

戻り値

基本クラスによって実装されているように、 OnPreRestore は常に true を返します。

致命的なエラーが発生した場合を除き、このメソッドの他の実装は true を返す必要があります。致命的なエラーが発生した場合、メソッドは CSVsWriter::SetWriterFailure メソッドを呼び出して、 false を返す前にエラーの説明を提供する必要があります。致命的でないエラーが発生した場合でも、メソッドは SetWriterFailure を 呼び出しますが 、true を返します。一時的な問題が原因でエラーが発生した場合、メソッドは SetWriterFailure の呼び出しでVSS_E_WRITERERROR_RETRYABLEを指定する必要があります。

エラーが発生した場合、メソッドはイベントログにイベントを書き込み、エラーの正確な理由を報告する必要があります。

注釈

PreRestore イベントは、バックアップされたデータが実際に復元される前に発生します。これは、ライターが復元対象を決定する機会です。

CVssWriter 基本クラスによるこのメソッドの既定の実装は、他の操作を実行せずに true を返します。

このメソッドを使用すると、ライターは復元対象を特定し、格納されているバックアップコンポーネントドキュメントに格納されているプライベートメタデータを取得し、そのデータを更新できます。

ライターは、このメソッドまたは他の CSVSWriter(Ex)::OnXxx コールバックメソッドから例外をスローしないでください。

このメソッドが CVssWriterEx2::GetSessionId、 CVssWriter::SetWriterFailure、または CVssWriterEx2::SetWriterFailureEx メソッドを呼び出す場合は、このメソッドを呼び出したのと同じスレッドで呼び出す必要があります。詳細については、「ライターイベント処理」を参照してください。

要件

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