CVssWriter::Metode OnPrepareBackup (vswriter.h)

Metode OnPrepareBackup dipanggil oleh penulis setelah peristiwa PrepareForBackup . Metode ini digunakan untuk mengonfigurasi status penulis dan komponennya sebagai persiapan untuk operasi pencadangan.

OnPrepareBackup adalah metode virtual. Ini diimplementasikan oleh kelas dasar CVssWriter , tetapi dapat ditimpa oleh kelas turunan.

Sintaks

bool OnPrepareBackup(
  [in] IVssWriterComponents *pComponent
);

Parameter

[in] pComponent

Penunjuk ke instansiasi objek IVssWriterComponents yang berisi konten Dokumen Metadata Penulis. Nilai parameter ini mungkin NULL jika pemohon tidak mendukung komponen (jika CVssWriter::AreComponentsSelected mengembalikan false).

Nilai kembali

Seperti yang diimplementasikan oleh kelas dasar, OnPrepareBackup selalu mengembalikan true.

Implementasi lain dari metode ini harus mengembalikan true kecuali dalam kasus kesalahan fatal. Jika terjadi kesalahan fatal, metode harus memanggil metode CVssWriter::SetWriterFailure untuk memberikan deskripsi kegagalan sebelum mengembalikan false. Jika terjadi kesalahan nonfatal, metode harus tetap memanggil SetWriterFailure tetapi mengembalikan true. Jika kesalahan disebabkan oleh masalah sementara, metode harus menentukan VSS_E_WRITERERROR_RETRYABLE dalam panggilan ke SetWriterFailure.

Dalam semua kasus ketika kegagalan terjadi, metode harus menulis peristiwa ke log peristiwa untuk melaporkan alasan pasti kegagalan tersebut.

Keterangan

Implementasi default metode ini oleh kelas dasar CVssWriter mengembalikan true tanpa melakukan operasi lainnya.

OnPrepareBackup memberi penulis kesempatan untuk memilih dengan lebih halus apa yang akan dicadangkan.

Menangani peristiwa PrepareForBackup adalah kesempatan terakhir bagi penulis untuk mendapatkan akses ke metadata yang terkandung dalam Dokumen Komponen Cadangan sebelum pembuatan salinan bayangan.

Oleh karena itu, OnPrepareBackup memberikan kesempatan bagi penulis untuk membuat penambahan akhir atau pembaruan pada informasi komponen yang disimpan (menggunakan antarmuka IVssComponent ). Secara khusus, metadata khusus penulis dapat diperbarui oleh IVssComponent::SetBackupMetadata atau IVssComponent::SetRestoreMetadata.

Selain itu, saat menangani peristiwa PrepareForSnapshot memberikan kesempatan lain dalam siklus hidup operasi pencadangan VSS untuk melakukan operasi yang memakan waktu (seperti menyinkronkan data di beberapa situs), OnPrepareBackup memberikan kesempatan bagi penulis untuk memulai operasi tersebut secara asinkron. Tugas seperti ini harus diselesaikan sebelum pengembalian CVssWriter::OnPrepareSnapshot.

Penulis tidak boleh melempar pengecualian dari metode ini atau CVssWriter (Ex): : Pada metode panggilan balikXxx .

Pemohon menghasilkan peristiwa PrepareForBackup , memicu panggilan ke OnPrepareBackup, dengan memanggil IVssBackupComponents::P repareForBackup.

Jika metode ini memanggil metode CVssWriterEx2::GetSessionId, CVssWriter::SetWriterFailure, atau CVssWriterEx2::SetWriterFailureEx , metode harus melakukannya dalam utas yang sama yang memanggil metode ini. Untuk informasi selengkapnya, lihat Penanganan Peristiwa Penulis.

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows XP [hanya aplikasi desktop]
Server minimum yang didukung Windows Server 2003 [hanya aplikasi desktop]
Target Platform Windows
Header vswriter.h (termasuk Vss.h, VsWriter.h)
Pustaka VssApi.lib

Lihat juga

CVssWriter

CVssWriter::OnPostSnapshot

CVssWriter::OnPreRestore

CVssWriter::SetWriterFailure

IVssWriterComponents