IVssCreateWriterMetadata::AddComponent method (vswriter.h)

  • Artikel

Metode AddComponent menambahkan database atau grup file sebagai komponen yang akan dicadangkan.

Sintaks

HRESULT AddComponent(
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszCaption,
  [in] const BYTE         *pbIcon,
  [in] UINT               cbIcon,
  [in] bool               bRestoreMetadata,
  [in] bool               bNotifyOnBackupComplete,
  [in] bool               bSelectable,
  [in] bool               bSelectableForRestore,
  [in] DWORD              dwComponentFlags
);

Parameter

[in] ct

Nilai enumerasi VSS_COMPONENT_TYPE yang menentukan jenis komponen.

Windows Server 2003 dan Windows XP: Sebelum Windows Server 2003 dengan SP1, parameter ini dicadangkan untuk penggunaan sistem, dan pemanggil tidak boleh mengambil alih nilai default.

[in] wszLogicalPath

Penunjuk ke string karakter lebar yang dihentikan null yang berisi jalur logis database atau grup file. Untuk informasi selengkapnya, lihat Jalur Logis Komponen.

Jalur logis bersifat opsional dan dapat berupa NULL.

[in] wszComponentName

Penunjuk ke string karakter lebar yang dihentikan null yang berisi nama komponen. String ini tidak dilokalkan.

Parameter ini diperlukan dan tidak boleh NULL. String tidak boleh berisi garis miring terbelakang.

[in] wszCaption

Penunjuk ke string karakter lebar yang dihentikan null yang berisi deskripsi (juga disebut "nama yang mudah diingat") untuk komponen. String ini mungkin dilokalkan, dan oleh karena itu pemohon harus berasumsi bahwa string ini dilokalkan.

Parameter ini bersifat opsional dan dapat berupa NULL. String dapat berisi garis miring terbelakang.

[in] pbIcon

Penunjuk ke bitmap ikon yang mewakili database, yang akan ditampilkan di antarmuka pengguna. Ukuran, dalam byte, dari buffer ditentukan oleh parameter cbIcon .

Jika penulis tidak ingin menentukan ikon, pbIcon harus diatur ke NULL.

[in] cbIcon

Ukuran, dalam byte, dari buffer. Jika parameter pbIcon adalah NULL, cbIcon harus nol.

[in] bRestoreMetadata

Parameter ini dicadangkan untuk digunakan di masa mendatang dan harus selalu diatur ke false.

[in] bNotifyOnBackupComplete

Parameter ini dicadangkan untuk digunakan di masa mendatang dan harus selalu diatur ke false.

[in] bSelectable

Boolean yang menunjukkan apakah komponen dapat dicadangkan secara opsional (yang berarti dapat dikecualikan dari cadangan) atau selalu dicadangkan ketika salah satu komponen penulis dicadangkan. Boolean benar jika komponen dapat dicadangkan secara selektif dan salah jika dicadangkan ketika salah satu komponen dicadangkan.

[in] bSelectableForRestore

Boolean yang menentukan apakah komponen dapat dipulihkan secara individual ketika belum disertakan secara eksplisit dalam dokumen cadangan. Jika komponen ditambahkan secara eksplisit ke dokumen cadangan, komponen selalu dapat dipilih secara individual untuk pemulihan; dalam hal ini, bendera ini tidak memiliki arti.

Jika true, komponen dapat dipulihkan dengan sendirinya; ketika false, komponen hanya dapat dipulihkan jika seluruh set komponen sedang dipulihkan. (Lihat VSS_COMPONENTINFO dan Bekerja dengan Selektifitas dan Jalur Logis untuk informasi selengkapnya).

Nilai default untuk parameter ini adalah false.

[in] dwComponentFlags

Masker bit (atau bitwise OR) dari anggota enumerasi VSS_COMPONENT_FLAGS yang menunjukkan fitur yang didukung komponen ini.

Nilai default untuk argumen ini adalah nol.

Mengembalikan nilai

Berikut ini adalah kode pengembalian yang valid untuk metode ini.

Nilai Makna
S_OK
 Operasi berhasil.
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.
VSS_E_OBJECT_ALREADY_EXISTS
 Objek adalah duplikat. Komponen dengan jalur logis dan nama komponen yang sama sudah ada.
VSS_E_UNEXPECTED
 Kesalahan tak terduga. Kode kesalahan dicatat dalam file log kesalahan. Untuk informasi selengkapnya, lihat Penanganan Peristiwa dan Kesalahan di bawah VSS.

Windows Server 2008, Windows Vista, Windows Server 2003 dan Windows XP: Nilai ini tidak didukung sampai Windows Server 2008 R2 dan Windows 7. E_UNEXPECTED digunakan sebagai gantinya.

Keterangan

Metode ini dapat dipanggil beberapa kali untuk menambahkan beberapa komponen ke metadata penulis.

Kombinasi jalur logis dan nama untuk setiap komponen instans tertentu dari kelas penulis tertentu harus unik. Mencoba memanggil AddComponent dua kali dengan nilai wszLogicalPath dan wszComponentName yang sama menghasilkan kesalahan VSS_E_OBJECT_ALREADY_EXISTS.

AddComponent dapat digunakan untuk menambahkan subkomponen—komponen di mana semua file anggota dicadangkan sebagai grup, tetapi yang berisi file yang dapat dipulihkan satu per satu. Lihat Bekerja dengan Keterpilihan untuk Pemulihan dan Subkomponen untuk informasi selengkapnya.

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

IVssCreateWriterMetadata