IWiaErrorHandler::GetStatusDescription 方法 (wia_lh.h)
如果使用者要求這項資訊,系統 UI 會呼叫 GetStatusDescription 方法,為使用者提供有關錯誤的額外資訊。 這個方法是由驅動程式的UI延伸模組所實作。
語法
HRESULT GetStatusDescription(
[in] LONG lFlags,
[in] IWiaItem2 *pWiaItem2,
[in] HRESULT hrStatus,
[out] BSTR *pbstrDescription
);
參數
[in] lFlags
目前未使用。 應該設定為零。
[in] pWiaItem2
正在傳輸 之 IWiaItem2 專案的指標。
[in] hrStatus
HRESULT 變數,其中包含 WIA 傳輸方法所接收的狀態代碼,例如 IWiaDataCallback::BandedDataCallback。
[out] pbstrDescription
BSTR 的指標,接收傳輸期間所發生狀態或錯誤的描述。 此參數不可為 NULL。 驅動程式必須使用 SysAllocString 函式配置字串,而且呼叫端必須使用 SysFreeString] (/windows/win32/api/oleauto/nf-oleauto-sysfreestring) 函式釋放字符串。
傳回值
如果發生錯誤,則傳回標準 COM 錯誤碼,或下列其中一項:
傳回碼 | 描述 |
---|---|
S_OK | pbstrDescription 參數包含有效的 BSTR 指標。 |
WIA_STATUS_NOT_HANDLED | hrStatus 參數中的值對延伸模組未知,而且沒有可用的描述。 |
備註
為了讓應用程式呼叫 IWiaErrorHandler::GetStatusDescription,應用程式必須先呼叫 IWiaItem2::GetExtension ,才能接收錯誤處理延伸模組的介面指標。 應用程式必須將 「ErrorHandler」 當做 bstrName 傳遞,並以 riidExtensionInterface 傳遞IID_IWiaErrorHandler。 應用程式應該以 lFlags 的形式傳遞 0,以確保向上相容性。
IWiaErrorHandler::GetStatusDescription 的實作應該會針對所有裝置狀態代碼傳回S_OK, (hrStatus) IWiaErrorHandler::ReportStatus 句柄的實作,以及 IWiaErrorHandler::ReportStatus 不會處理的裝置狀態代碼WIA_STATUS_NOT_HANDLED。
規格需求
需求 | 值 |
---|---|
目標平台 | 桌面 |
標頭 | wia_lh.h (包含 Wia_lh.h) |