Metode IWiaErrorHandler::ReportStatus (wia_lh.h)

Metode ReportStatus menampilkan informasi tentang kesalahan atau status selama transfer. Dalam beberapa kasus, metode ini memungkinkan pengguna untuk pulih dari kesalahan.

Sintaks

HRESULT ReportStatus(
  [in] LONG      lFlags,
  [in] HWND      hwndParent,
  [in] IWiaItem2 *pWiaItem2,
  [in] HRESULT   hrStatus,
  [in] LONG      lPercentComplete
);

Parameter

[in] lFlags

Saat ini tidak digunakan. Harus diatur ke nol.

[in] hwndParent

Handel penelepon yang disediakan dari jendela yang harus digunakan sebagai jendela induk untuk kotak dialog apa pun. Jika ini diatur ke NULL, tidak ada kotak dialog yang harus ditampilkan.

[in] pWiaItem2

Penunjuk ke itemIWiaItem2 yang sedang ditransfer.

[in] hrStatus

Variabel HRESULT yang berisi kode status yang diterima oleh metode transfer WIA, misalnya metode IWiaDataCallback::BandedDataCallback .

[in] lPercentComplete

Ukuran data, dalam byte, yang dirujuk oleh penunjuk pbData .

Nilai kembali

Mengembalikan kode kesalahan COM standar jika kesalahan tidak dapat dipulihkan, atau jika pengguna memilih untuk membatalkan transfer sebagai respons terhadap kotak dialog yang ditampilkan. Ada informasi tambahan tentang nilai yang dikembalikan di bagian keterangan. Jika tidak, metode ini mengembalikan salah satu nilai berikut:

Menampilkan kode Deskripsi
S_OK Tindakan yang sesuai diambil untuk memperbaiki kesalahan dan transfer dapat dilanjutkan.
S_FALSE Tidak ada tindakan yang diambil untuk menangani kesalahan atau melaporkan status kepada pengguna.

Keterangan

Objek panggilan balik proksi COM memanggil metode WiaErrorHandler::ReportStatus ketika driver mengirim pesan IT_MSG_DEVICE_STATUS ke metode IWiaDataCallback::BandedDataCallback . Kotak dialog yang ditampilkan metode ini memberi pengguna informasi kesalahan atau status dan mungkin memberikan kesempatan untuk pulih dari kesalahan dan melanjutkan transfer. UI hanya boleh menyediakan kotak dialog informasi dan kesempatan untuk membatalkan transfer jika HRESULT SEVERITY_SUCCESS.

Driver yang menerapkan metode ini, harus menampilkan kotak dialog modal, yang dimiliki oleh hwndParent, sebagai respons terhadap nilai hrStatus yang failed(hrStatus) dievaluasi ke TRUE. Jika FAILED(hrStatus) mengevaluasi ke FALSE, nilai dalam hrStatus mewakili penundaan nonfaktor, dan kotak dialog yang ditampilkan harus modeless. Kotak dialog harus dihapus saat status transfer berubah. Handler kesalahan harus mengembalikan S_FALSE untuk nilai hrStatus yang tidak diketahui.

Parameter hrStatus diatur ke WIA_STATUS_TRANSFER_BEGIN untuk memberi tahu handler bahwa transfer telah dimulai. Ini diatur ke WIA_STATUS_TRANSFER_END ketika transfer selesai.

Jika hrStatus S_OK, transfer data telah dilanjutkan dan tidak ada penundaan atau kesalahan yang saat ini berlaku.

Persyaratan

Persyaratan Nilai
Target Platform Desktop
Header wia_lh.h (termasuk Wia_lh.h)

Lihat juga

IWiaErrorHandler

IWiaErrorHandler::GetStatusDescription