struktur VSS_COMPONENTINFO (vsbackup.h)

Artikel
08/27/2023

Struktur VSS_COMPONENTINFO berisi informasi tentang komponen tertentu, dan dikembalikan ke pemohon oleh antarmuka IVssWMComponent .

Sintaks

typedef struct _VSS_COMPONENTINFO {
  VSS_COMPONENT_TYPE type;
  BSTR               bstrLogicalPath;
  BSTR               bstrComponentName;
  BSTR               bstrCaption;
  BYTE               *pbIcon;
  UINT               cbIcon;
  bool               bRestoreMetadata;
  bool               bNotifyOnBackupComplete;
  bool               bSelectable;
  bool               bSelectableForRestore;
  DWORD              dwComponentFlags;
  UINT               cFileCount;
  UINT               cDatabases;
  UINT               cLogFiles;
  UINT               cDependencies;
} VSS_COMPONENTINFO;

Anggota

type

Jenis komponen. Lihat VSS_COMPONENT_TYPE.

bstrLogicalPath

String yang berisi jalur logis komponen.

Jalur logis bisa NULL.

Tidak ada batasan pada karakter yang dapat muncul di jalur logika non-NULL .

bstrComponentName

String yang berisi nama komponen. String nama komponen tidak boleh NULL.

bstrCaption

String yang berisi deskripsi komponen. String caption bisa NULL.

pbIcon

Penunjuk ke buffer yang berisi data biner untuk ikon yang dapat ditampilkan yang mewakili komponen. Konten buffer harus menggunakan format yang sama dengan file ikon standar (.ico). Ukuran, dalam byte, dari buffer ditentukan oleh cbIcon.

Jika penulis yang membuat komponen tidak memilih untuk menentukan ikon, pbIcon adalah NULL.

cbIcon

Ukuran, dalam byte, dari ikon yang dapat ditampilkan (pbIcon) yang mewakili komponen. Jika pbIcon adalah NULL, cbIcon harus nol.

bRestoreMetadata

Boolean yang menunjukkan apakah ada metadata privat yang terkait dengan pemulihan komponen. Boolean benar jika ada metadata dan false jika tidak ada.

Penulis menunjukkan apakah komponen mendukung metadata privat dengan mengatur nilai ini saat komponen ditambahkan dengan IVssCreateWriterMetadata::AddComponent. Penulis kemudian menambahkan metadata pemulihan dengan IVssComponent::SetRestoreMetadata. Pemohon mengambil informasi menggunakan IVssComponent::GetRestoreMetadata.

bNotifyOnBackupComplete

Disiapkan untuk penggunaan masa mendatang. Nilai parameter ini harus selalu diatur ke false.

bSelectable

Boolean yang menunjukkan (untuk operasi mode komponen) jika komponen dapat dipilih untuk pencadangan. Nilai bSelectable membantu menentukan apakah pemohon memiliki opsi untuk menyertakan atau mengecualikan komponen tertentu dalam operasi pencadangan. Boolean benar jika komponen dapat dipilih untuk cadangan dan false jika tidak.

Tidak ada nilai default untuk keterpilih komponen untuk pencadangan. Penulis harus selalu secara eksplisit mengatur nilai saat menambahkan komponen ke Dokumen Metadata Penulis menggunakan IVssCreateWriterMetadata::AddComponent.

Selain itu, nilai bSelectable, jalur logis komponen, dan hubungan komponen dengan komponen lain seperti yang dinyatakan dalam jalur tersebut menentukan kapan dan bagaimana komponen disertakan dalam operasi pencadangan:

Untuk komponen cadangan yang tidak dapat dipilih (bSelectable is false) tanpa dapat dipilih untuk leluhur cadangan dalam hierarki jalur logisnya, penyertaan dalam kumpulan cadangan selalu wajib dan selalu implisit. Pemohon secara eksplisit menambahkan komponen ke kumpulan cadangan di Dokumen Komponen Cadangan dengan IVssBackupComponents::AddComponent.
Untuk komponen cadangan yang dapat dipilih (bSelectable is true) tanpa dapat dipilih untuk leluhur cadangan dalam hierarki jalur logisnya, penyertaan dalam kumpulan cadangan selalu opsional dan selalu eksplisit. Pemohon secara eksplisit menambahkan komponen ke kumpulan cadangan di Dokumen Komponen Cadangan dengan IVssBackupComponents::AddComponent.
Jika komponen seperti itu disertakan sebagai leluhur di jalur logis komponen lain, baik komponen yang dapat dipilih untuk cadangan maupun yang tidak, komponen mendefinisikan set komponen yang berisi komponen lain ini sebagai subkomponen. Jika yang dapat dipilih untuk komponen cadangan secara eksplisit disertakan dalam cadangan, subkomponen ini secara implisit disertakan dalam cadangan.
Untuk komponen cadangan yang tidak dapat dipilih (bSelectable is false) yang memiliki pilihan untuk leluhur cadangan dalam hierarki jalur logisnya (dan oleh karena itu merupakan bagian dari set komponen yang ditentukan oleh leluhur tersebut), penyertaan dalam kumpulan cadangan selalu implisit dan kontingen pada penyertaan yang dapat dipilih untuk leluhur cadangan. Pemohon tidak pernah secara eksplisit menambahkan komponen ke kumpulan cadangan dalam Dokumen Komponen Cadangan; sebaliknya, ia menambahkan yang dapat dipilih untuk leluhur cadangan ke dokumen menggunakan IVssBackupComponents::AddComponent.
Untuk komponen cadangan yang dapat dipilih (bSelectable is true) yang memiliki pilihan untuk leluhur cadangan dalam hierarki jalur logisnya (dan oleh karena itu merupakan bagian dari set komponen yang ditentukan oleh leluhur tersebut), penyertaan dalam kumpulan cadangan dapat bersifat opsional dan eksplisit, atau jika komponen tidak dipilih secara eksplisit, penyertaannya mungkin implisit dan kontingen pada penyertaan yang dapat dipilih untuk leluhur cadangan. Jika penyertaan komponen bersifat eksplisit, pemohon secara eksplisit menambahkan komponen ke kumpulan cadangan dalam Dokumen Komponen Cadangan dengan IVssBackupComponents::AddComponent.
Jika penyertaan bersifat implisit, pemohon tidak menambahkan komponen ini ke kumpulan cadangan dalam Dokumen Komponen Cadangan.

Jika penyertaan komponen eksplisit dan komponen menentukan set komponen, anggota set komponen tersebut dipilih secara implisit.

Penulis menetapkan keterpilihan komponen untuk cadangan (bSelectable) saat menambahkan komponen ke Dokumen Metadata Penulis dengan menggunakan IVssCreateWriterMetadata::AddComponent.

Lihat Bekerja dengan Selektifitas dan Jalur Logis untuk informasi selengkapnya.

bSelectableForRestore

Boolean yang menunjukkan (untuk operasi mode komponen) apakah komponen dapat dipilih untuk pemulihan. bSelectableForRestore memungkinkan pemohon untuk menentukan apakah komponen ini dapat dipilih secara individual untuk pemulihan jika sebelumnya telah secara implisit disertakan dalam cadangan. Boolean benar jika komponen dapat dipilih untuk pemulihan dan false jika tidak.

Secara default, pilihan komponen untuk pemulihan adalah false. Penulis dapat mengambil alih default ini saat menambahkan komponen ke Dokumen Metadata Penulis menggunakan IVssCreateWriterMetadata::AddComponent.

Jika komponen secara eksplisit ditambahkan ke dokumen cadangan (lihat penyertaan komponen eksplisit), komponen tersebut selalu dapat dipilih secara individual untuk pemulihan; jadi bendera ini kemudian tidak memiliki arti. Jika komponen secara implisit ditambahkan ke dokumen cadangan, maka bendera bSelectableForRestore menentukan apakah komponen dapat dipulihkan secara individual menggunakan IVssBackupComponents::AddRestoreSubcomponent.

Lihat Bekerja dengan Selektifitas dan Jalur Logis untuk informasi selengkapnya.

dwComponentFlags

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

Windows Server 2003 dan Windows XP: Sebelum Windows Server 2003 dengan SP1, anggota ini dicadangkan untuk penggunaan sistem.

cFileCount

Jika komponen adalah grup file, jumlah deskriptor file untuk file dalam grup. Jika tidak, nilai ini adalah nol.

cDatabases

Jika komponen adalah database, jumlah pendeskripsi file database. Jika tidak, nilai ini adalah nol.

cLogFiles

Jika komponen adalah database, jumlah pendeskripsi file log database. Jika tidak, nilai parameter ini adalah nol.

cDependencies

Jumlah dependensi komponen penulis eksplisit dari komponen saat ini. Nilai ini bertambah ketika IVssCreateWriterMetadata::AddComponentDependency dipanggil oleh penulis.

Keterangan

Untuk mendapatkan objek VSS_COMPONENTINFO untuk komponen tertentu, pemohon harus terlebih dahulu mendapatkan objek IVssWMComponent yang sesuai melalui panggilan ke IVssExamineWriterMetadata::GetComponent. Panggilan ke IVssWMComponent::GetComponentInfo kemudian mengalokasikan dan mengembalikan struktur VSS_COMPONENTINFO .

Karena VSS_COMPONENTINFO dialokasikan dan dikembalikan oleh IVssWMComponent::GetComponentInfo, pemohon tidak boleh membebaskan objek VSS_COMPONENTINFO secara langsung, tetapi harus menggunakan IVssWMComponent::FreeComponentInfo.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Header	vsbackup.h (termasuk VsBackup.h, Vss.h, VsWriter.h)