Метод IWiaErrorHandler::GetStatusDescription (wia_lh.h)

2025-02-07

Системный пользовательский интерфейс вызывает метод 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 (include Wia_lh.h)

См. также

IWiaErrorHandler

IWiaErrorHandler::ReportStatus