Metode IVssComponent::GetPartialFile (vswriter.h)

  • Artikel

Metode GetPartialFile mengembalikan informasi tentang file parsial yang terkait dengan komponen ini.

Sintaks

HRESULT GetPartialFile(
  [in]  UINT iPartialFile,
  [out] BSTR *pbstrPath,
  [out] BSTR *pbstrFilename,
  [out] BSTR *pbstrRange,
  [out] BSTR *pbstrMetadata
);

Parameter

[in] iPartialFile

Nomor indeks file parsial. Nilai parameter ini adalah bilangan bulat dari 0 hingga n–1 inklusif, di mana n adalah jumlah total file parsial yang terkait dengan komponen tertentu. Nilai n dikembalikan oleh IVssComponent::GetPartialFileCount.

[out] pbstrPath

Penunjuk ke string yang berisi jalur file parsial.

Pengguna metode ini perlu memeriksa untuk menentukan apakah jalur ini berakhir dengan garis miring terbelakang ("").

[out] pbstrFilename

Penunjuk ke string yang berisi nama file parsial.

[out] pbstrRange

Penunjuk ke string yang berisi daftar offset dan panjang file yang membentuk rentang dukungan file parsial (bagian file yang dicadangkan), atau nama file yang berisi daftar tersebut.

[out] pbstrMetadata

Penunjuk ke string yang berisi metadata tambahan yang diperlukan oleh penulis untuk memvalidasi operasi pemulihan file parsial. Informasi dalam string metadata ini akan buram bagi pemohon.

Metadata tambahan tidak diperlukan, sehingga pbstrMetadata mungkin juga kosong (panjang nol).

Nilai kembali

Berikut ini adalah kode pengembalian yang valid untuk metode ini.

Nilai Makna
S_OK
 Berhasil mengembalikan nilai atribut.
E_INVALIDARG
 Salah satu nilai parameter tidak valid.
E_OUTOFMEMORY
 Pemanggil kehabisan memori atau sumber daya sistem lainnya.
VSS_E_BAD_STATE
 Pemanggil tidak dalam status yang benar (baik pencadangan atau pemulihan) untuk operasi.
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_NOT_FOUND
 Item yang ditentukan tidak ditemukan.

Keterangan

Pemanggil harus membebaskan memori yang dipegang oleh parameter pbstrPath, pbstrFilename, pbstrRange, dan pbstrMetadata dengan memanggil SysFreeString.

Rentang menunjukkan subbagian file tertentu yang akan dicadangkan, terlepas dari sisa file.

Sintaks daftar rentang (pbstrRanges) adalah dari daftar yang dipisahkan koma dari formulir offset1:length1, offset2:length2, di mana setiap offset dan panjang adalah bilangan bulat 64-bit yang menentukan offset byte dan panjang dalam byte, masing-masing. Offset dan panjang dapat diekspresikan baik sebagai nilai heksadesimal atau desimal.

Jika pbstrRanges mengacu pada file yang berisi semua offset dan panjang (file rentang), pbstrRanges harus berisi jalur lengkap ke file.

Jika wszRange mengacu pada file yang berisi semua offset dan panjang (file rentang), wszRange harus berisi jalur lengkap ke file.

File rentang harus berupa file biner dengan format berikut:

  1. Bilangan bulat 64-bit yang menunjukkan jumlah rentang file berbeda yang perlu dicadangkan.
  2. Setiap rentang yang dinyatakan sebagai sepasang bilangan bulat 64-bit: offset ke dalam file yang dicadangkan, dalam byte, dan panjang data mulai dari offset tersebut untuk dicadangkan.
File rentang seharusnya telah dicadangkan bersama dengan file parsial dan biasanya dipulihkan ke lokasi yang sama dengan tempat file dicadangkan.

Namun, lokasi di mana file rentang dipulihkan mungkin diubah oleh pemohon, yang menggunakan IVssBackupComponents::SetRangesFilePath untuk menunjukkan hal ini dan untuk memperbarui Dokumen Komponen Cadangan sehingga pbstrRanges menunjukkan file rentang yang benar.

Pemohon akan menggunakan informasi rentang yang dikembalikan oleh GetPartialFile untuk memulihkan bagian yang dicadangkan ke lokasi yang sesuai dalam salinan file pada disk pada waktu pemulihan.

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

IVssBackupComponents::SetRangesFilePath

IVssComponent

IVssComponent::AddPartialFile

IVssComponent::GetPartialFileCount