Metode IVssBackupComponents::GetWriterStatus (vsbackup.h)

Artikel
03/03/2024

Metode GetWriterStatus mengembalikan status penulis yang ditentukan.

Sintaks

HRESULT GetWriterStatus(
  [in]  UINT             iWriter,
  [out] VSS_ID           *pidInstance,
  [out] VSS_ID           *pidWriter,
  [out] BSTR             *pbstrWriter,
  [out] VSS_WRITER_STATE *pnStatus,
  [out] HRESULT          *phResultFailure
);

Parameter

[in] iWriter

Indeks penulis yang metadatanya akan diambil. Nilai parameter ini adalah bilangan bulat dari 0 hingga n–1 inklusif, di mana n adalah jumlah total penulis pada sistem saat ini. Nilai n dikembalikan oleh IVssBackupComponents::GetWriterStatusCount.

[out] pidInstance

Alamat variabel yang dialokasikan penelepon yang menerima pengidentifikasi instans penulis.

[out] pidWriter

Alamat variabel yang dialokasikan penelepon yang menerima pengidentifikasi untuk kelas penulis.

[out] pbstrWriter

Alamat variabel yang dialokasikan penelepon yang menerima string yang berisi nama penulis yang ditentukan.

[out] pnStatus

Alamat variabel yang dialokasikan penelepon yang menerima nilai enumerasi VSS_WRITER_STATE .

[out] phResultFailure

Alamat variabel yang dialokasikan penelepon yang menerima kode kegagalan HRESULT yang dikembalikan oleh penulis.

Berikut ini adalah nilai yang didukung untuk pHrResultFailure.

Nilai	Makna
S_OK	Penulis berhasil.
VSS_E_WRITERERROR_INCONSISTENTSNAPSHOT	Salinan bayangan hanya berisi subset volume yang diperlukan oleh penulis untuk mencadangkan komponen aplikasi dengan benar.
VSS_E_WRITERERROR_OUTOFRESOURCES	Penulis kehabisan memori atau sumber daya sistem lainnya. Cara yang disarankan untuk menangani kode kesalahan ini adalah dengan menunggu sepuluh menit dan kemudian mengulangi operasi, hingga tiga kali.
VSS_E_WRITERERROR_TIMEOUT	Operasi penulis gagal karena waktu habis antara peristiwa Freeze dan Thaw. Cara yang disarankan untuk menangani kode kesalahan ini adalah dengan menunggu sepuluh menit dan kemudian mengulangi operasi, hingga tiga kali.
VSS_E_WRITERERROR_RETRYABLE	Penulis gagal karena kesalahan yang kemungkinan tidak akan terjadi jika seluruh proses pembuatan cadangan, pemulihan, atau salinan bayangan dimulai ulang. Cara yang disarankan untuk menangani kode kesalahan ini adalah dengan menunggu sepuluh menit dan kemudian mengulangi operasi, hingga tiga kali.
VSS_E_WRITERERROR_NONRETRYABLE	Operasi penulis gagal karena kesalahan yang mungkin berulang jika salinan bayangan lain dibuat. Untuk informasi selengkapnya, lihat Penanganan Peristiwa dan Kesalahan di bawah VSS.
VSS_E_WRITER_NOT_RESPONDING	Penulis tidak merespons.
VSS_E_WRITER_STATUS_NOT_AVAILABLE	Status penulis tidak tersedia untuk satu atau beberapa penulis. Penulis mungkin telah mencapai jumlah maksimum sesi pencadangan dan pemulihan yang tersedia. Windows Vista, Windows Server 2003, dan Windows XP: Nilai ini tidak didukung.

Nilai kembali

Berikut ini adalah kode pengembalian yang valid untuk metode ini.

Nilai	Makna
S_OK	Berhasil mengembalikan status penulis yang ditentukan. Perhatikan bahwa nilai parameter pHrWriterFailure harus diperiksa untuk memverifikasi bahwa penulis berhasil. Kode kegagalan penulis dapat berada di antara yang tercantum di VsWriter.h dan di Writer Errors and Vetoes.
E_INVALIDARG	Salah satu nilai parameter tidak valid.
E_OUTOFMEMORY	Pemanggil kehabisan memori atau sumber daya sistem lainnya.
VSS_E_BAD_STATE	Objek komponen cadangan tidak diinisialisasi, metode ini telah dipanggil selama operasi pemulihan, atau metode ini belum dipanggil dalam urutan yang benar.
VSS_E_OBJECT_NOT_FOUND	Penulis yang ditentukan tidak 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

Pemohon harus memanggil operasi asinkron IVssBackupComponents::GatherWriterStatus dan menunggunya selesai sebelum memanggil GetWriterStatus.

Ketika pemanggil telah selesai mengakses informasi status yang dikembalikan oleh metode ini, pemanggil harus memanggil SysFreeString untuk membebaskan memori yang dipegang oleh parameter pbstrWriter .

Nilai VSS_E_WRITERERROR_XXX yang dikembalikan dalam parameter pHrResultFailure dihasilkan oleh penulis. VSS_E_WRITER_NOT_RESPONDING dan VSS_E_WRITER_STATUS_NOT_AVAILABLE dihasilkan oleh VSS.

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	vsbackup.h (termasuk VsBackup.h, Vss.h, VsWriter.h)
Pustaka	VssApi.lib

Lihat juga

IVssBackupComponents

IVssBackupComponents::GatherWriterStatus

IVssBackupComponents::GetWriterStatusCount

Bagikan melalui