Metode IVssCreateWriterMetadata::AddFilesToFileGroup (vswriter.h)
Metode AddFilesToFileGroup menambahkan set file (file atau file tertentu) ke komponen grup file tertentu.
Sintaks
HRESULT AddFilesToFileGroup(
[in] LPCWSTR wszLogicalPath,
[in] LPCWSTR wszGroupName,
[in] LPCWSTR wszPath,
[in] LPCWSTR wszFilespec,
[in] bool bRecursive,
[in] LPCWSTR wszAlternateLocation,
[in] DWORD dwBackupTypeMask
);
Parameter
[in] wszLogicalPath
Penunjuk ke string karakter lebar yang dihentikan null yang berisi jalur logis (yang mungkin NULL) dari komponen untuk menambahkan file. Untuk informasi selengkapnya, lihat Jalur Komponen Logis.
[in] wszGroupName
Penunjuk ke string karakter lebar yang dihentikan null yang berisi nama komponen grup file. Jenis komponen ini harus VSS_CT_FILEGROUP; jika tidak, metode akan mengembalikan kesalahan.
[in] wszPath
Penunjuk ke string karakter lebar yang dihentikan null yang berisi direktori akar default file yang akan ditambahkan.
Direktori dapat menjadi direktori lokal pada komputer VSS, atau dapat menjadi direktori berbagi file di server file jarak jauh.
Jalur UNC didukung.
Jalur dapat berisi variabel lingkungan (misalnya, %SystemRoot%) tetapi tidak dapat berisi karakter kartubebas.
Tidak ada persyaratan bahwa jalur berakhir dengan garis miring terbelakang (""). Terserah aplikasi yang mengambil informasi ini untuk diperiksa.
[in] wszFilespec
Penunjuk ke string karakter lebar yang dihentikan null yang berisi spesifikasi file file yang akan disertakan.
Spesifikasi file tidak boleh berisi spesifikasi direktori (misalnya, tidak ada garis miring terbelakang) tetapi dapat berisi ? dan * karakter kartubebas.
[in] bRecursive
Nilai Boolean yang menentukan apakah jalur yang ditentukan oleh parameter wszPath hanya mengidentifikasi satu direktori atau jika menunjukkan hierarki direktori yang akan dilalui secara rekursif. Parameter ini harus diatur ke true jika jalur diperlakukan sebagai hierarki direktori untuk diulang, atau salah sebaliknya.
Untuk informasi tentang melintasi folder yang dipasang, lihat Bekerja dengan Folder yang Dipasang dan Titik Pemilahan Ulang.
[in] wszAlternateLocation
Penunjuk ke string karakter lebar yang dihentikan null yang berisi jalur alternatif, yang sebenarnya berisi file yang akan dicadangkan dengan komponen ini.
Direktori dapat menjadi direktori lokal pada komputer VSS, atau dapat menjadi direktori berbagi file di server file jarak jauh.
Jalur UNC didukung.
Menentukan jalur alternatif bersifat opsional; jika tidak ada jalur alternatif yang diperlukan, wszAlternatePath harus NULL.
Jalur alternatif tidak boleh dikacaukan dengan pemetaan lokasi alternatif.
[in] dwBackupTypeMask
Bitmask nilai enumerasi VSS_FILE_SPEC_BACKUP_TYPE untuk menunjukkan apakah penulis harus mengevaluasi file untuk partisipasi dalam jenis operasi pencadangan tertentu.
Nilai default untuk argumen ini adalah (VSS_FSBT_ALL_BACKUP_REQUIRED | VSS_FSBT_ALL_SNAPSHOT_REQUIRED).
Nilai kembali
Berikut ini adalah kode pengembalian yang valid untuk metode ini.
| Nilai | Makna |
|---|---|
|
Operasi berhasil. |
|
Salah satu nilai parameter tidak valid, atau pemanggil mencoba menambahkan file grup file ke komponen non-grup file. |
|
Pemanggil kehabisan memori atau sumber daya sistem lainnya. |
|
Dokumen XML tidak valid. Periksa log peristiwa untuk detailnya. Untuk informasi selengkapnya, lihat Penanganan Peristiwa dan Kesalahan di bawah VSS. |
|
Untuk penulis ekspres, nilai wszAlternatePath harus NULL, dan bitmask dwBackupTypeMask tidak dapat menyertakan VSS_FSBT_DIFFERENTIAL_BACKUP_REQUIRED, VSS_FSBT_INCREMENTAL_BACKUP_REQUIRED, atau VSS_FSBT_LOG_BACKUP_REQUIRED. |
|
Komponen yang ditentukan tidak ada. |
|
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
Windows 7, Windows Server 2008 R2, Windows Vista, Windows Server 2008, Windows XP, dan Windows Server 2003: Berbagi file jarak jauh tidak didukung hingga Windows 8 dan Windows Server 2012. Penulis hanya mendukung sumber daya lokal—kumpulan file yang jalur absolutnya dimulai dengan spesifikasi volume lokal yang valid dan tidak dapat menjadi drive jaringan yang dipetakan. Oleh karena itu, input jalur (wszPath dan wszAlternatePath) ke AddFilesToFileGroup (setelah resolusi variabel lingkungan apa pun) harus dalam format ini.
Penulis dapat memanggil metode ini beberapa kali untuk menambahkan beberapa set file ke komponen grup filenya. Namun, Anda harus memastikan bahwa spesifikasi file tidak tumpang tindih, karena file tertentu hanya dapat ditentukan sekali.
Lokasi tempat file dicadangkan dan dipulihkan tergantung pada nilai untuk direktori akar yang ditentukan oleh wszPath dan jalur alternatif yang ditentukan oleh wszAlternatePath.
Perhatikan hal berikut saat menggunakan informasi jalur yang disediakan oleh AddFilesToFileGroup:
- Operasi pemulihan harus (jika memungkinkan) memulihkan file yang ditambahkan ke komponen oleh AddFilesToFileGroup di bawah direktori akar default yang ditentukan oleh wszPath.
- Jika jalur alternatif tidak ditentukan (jika wszAlternatePathADALAH NULL), file yang ditambahkan ke komponen akan dicadangkan dari direktori akar default dan dipulihkan ke direktori akar default yang ditunjukkan oleh wszPath.
- Jika jalur alternatif ditentukan (jika wszAlternatePathnon-NULL), file yang ditambahkan ke komponen dicadangkan dari jalur alternatif yang ditentukan oleh wszAlternatePath. Namun, pemohon masih akan menggunakan wszPath sebagai lokasi pemulihan default.
- Jika jalur alternatif ditentukan (wszAlternatePathnon-NULL) dan ada file yang cocok dengan spesifikasi file (wszFilespec) di jalur alternatif dan direktori akar default (wszPath), maka operasi pencadangan harus mencadangkan file yang terletak di bawah jalur alternatif, bukan file yang terletak di bawah direktori akar default.
- File harus dipulihkan ke direktori yang ditunjukkan oleh wszPath kecuali pemetaan lokasi alternatif ditetapkan oleh IVssCreateWriterMetadata::AddAlternateLocationMapping dan metode pemulihan atau target pemulihan memerlukannya.
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 |