Metode IVssComponent::GetBackupMetadata (vswriter.h)

  • Artikel

Metode GetBackupMetadata mengambil metadata cadangan privat khusus penulis yang mungkin telah diatur selama peristiwa PrepareForBackup oleh CVssWriter::OnPrepareBackup menggunakan IVssComponent::SetBackupMetadata.

Hanya penulis yang dapat memanggil metode ini.

Sintaks

HRESULT GetBackupMetadata(
  [out] BSTR *pbstrData
);

Parameter

[out] pbstrData

Alamat variabel yang dialokasikan pemanggil yang menerima string yang berisi metadata cadangan yang ditambahkan selama peristiwa OnPrepareBackup .

Nilai kembali

Berikut ini adalah kode pengembalian yang valid untuk metode ini.

Nilai Makna
S_OK
 Berhasil mengembalikan nilai atribut.
S_FALSE
 Tidak ada metadata cadangan yang terkait dengan komponen ini.
E_INVALIDARG
 Salah satu nilai parameter tidak valid.
E_OUTOFMEMORY
 Pemanggil kehabisan memori atau sumber daya sistem lainnya.
VSS_E_INVALID_XML_DOCUMENT
 Dokumen XML tidak valid. Periksa log peristiwa untuk detailnya. Untuk informasi selengkapnya, lihat Penanganan Peristiwa dan Kesalahan di bawah VSS.

Keterangan

Metode ini dapat dipanggil kapan saja tergantung pada logika penulis tertentu.

Jika tidak ada metadata cadangan yang ditetapkan, GetBackupMetadata mengembalikan S_FALSE.

Jika panggilan ke GetBackupMetadata berhasil, pemanggil bertanggung jawab untuk membebaskan string yang dikembalikan dalam parameter pbstrMetadata dengan memanggil fungsi SysFreeString .

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

IVssComponent

IVssComponent::SetBackupMetadata