Metode IWiaErrorHandler::GetStatusDescription (wia_lh.h)
UI sistem memanggil metode GetStatusDescription untuk memberi pengguna informasi tambahan tentang kesalahan, jika pengguna meminta informasi ini. Metode ini diimplementasikan oleh ekstensi UI driver.
Sintaks
HRESULT GetStatusDescription(
[in] LONG lFlags,
[in] IWiaItem2 *pWiaItem2,
[in] HRESULT hrStatus,
[out] BSTR *pbstrDescription
);
Parameter
[in] lFlags
Saat ini tidak digunakan. Harus diatur ke nol.
[in] pWiaItem2
Penunjuk ke item IWiaItem2 yang sedang ditransfer.
[in] hrStatus
Variabel HRESULT yang berisi kode status yang diterima oleh metode transfer WIA, misalnya IWiaDataCallback::BandedDataCallback.
[out] pbstrDescription
Pointer ke BSTR yang menerima deskripsi status atau kesalahan yang ditemui selama transfer. Parameter ini tidak boleh NULL. Driver harus mengalokasikan string menggunakan fungsi SysAllocString dan pemanggil harus membebaskan string menggunakan fungsi SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring).
Nilai kembali
Mengembalikan kode kesalahan COM standar jika terjadi kesalahan, atau salah satu hal berikut ini:
| Menampilkan kode | Deskripsi |
|---|---|
| S_OK | Parameter pbstrDescription berisi penunjuk BSTR yang valid. |
| WIA_STATUS_NOT_HANDLED | Nilai dalam parameter hrStatus tidak diketahui oleh ekstensi dan tidak ada deskripsi yang tersedia. |
Keterangan
Agar aplikasi dapat memanggil IWiaErrorHandler::GetStatusDescription, aplikasi harus memanggil IWiaItem2::GetExtension terlebih dahulu untuk menerima penunjuk antarmuka ke ekstensi penanganan kesalahan. Aplikasi harus melewati "ErrorHandler" sebagai bstrName dan IID_IWiaErrorHandler sebagai riidExtensionInterface. Aplikasi harus melewati 0 sebagai lFlags untuk memastikan kompatibilitas ke atas.
Implementasi IWiaErrorHandler::GetStatusDescription harus mengembalikan S_OK untuk semua kode status perangkat (hrStatus) yang tidak ditangani implementasi IWiaErrorHandler::ReportStatus , dan WIA_STATUS_NOT_HANDLED untuk yang tidak ditangani IWiaErrorHandler::ReportStatus .
Persyaratan
| Persyaratan | Nilai |
|---|---|
| Target Platform | Desktop |
| Header | wia_lh.h (termasuk Wia_lh.h) |