Метод IWiaErrorHandler::GetStatusDescription (wia_lh.h)
Системный пользовательский интерфейс вызывает метод GetStatusDescription , чтобы предоставить пользователю дополнительные сведения об ошибке, если пользователь запрашивает эти сведения. Этот метод реализуется расширением пользовательского интерфейса драйвера.
Синтаксис
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 и IID_IWiaErrorHandler как riidExtensionInterface. Приложение должно передавать 0 в виде lFlags, чтобы обеспечить совместимость вверх.
Реализация IWiaErrorHandler::GetStatusDescription должна возвращать S_OK для всех кодов состояния устройства (hrStatus), обрабатываемых реализацией IWiaErrorHandler::ReportStatus , и WIA_STATUS_NOT_HANDLED для тех, которые IWiaErrorHandler::ReportStatus не обрабатывает.
Требования
| Требование | Значение |
|---|---|
| Целевая платформа | Персональный компьютер |
| Верхняя часть | wia_lh.h (включая Wia_lh.h) |