Método IWiaErrorHandler::GetStatusDescription (wia_lh.h)
La interfaz de usuario del sistema llama al método GetStatusDescription para proporcionar al usuario información adicional sobre un error, si el usuario solicita esta información. Este método se implementa mediante la extensión de interfaz de usuario de un controlador.
Sintaxis
HRESULT GetStatusDescription(
[in] LONG lFlags,
[in] IWiaItem2 *pWiaItem2,
[in] HRESULT hrStatus,
[out] BSTR *pbstrDescription
);
Parámetros
[in] lFlags
Actualmente no se usa. Debe establecerse como cero.
[in] pWiaItem2
Puntero al elemento IWiaItem2 que se va a transferir.
[in] hrStatus
Variable HRESULT que contiene el código de estado recibido por el método de transferencia WIA, por ejemplo , IWiaDataCallback::BandedDataCallback.
[out] pbstrDescription
Puntero a un BSTR que recibe una descripción del estado o error detectado durante la transferencia. Este parámetro no puede ser NULL. El controlador debe asignar la cadena mediante la función SysAllocString y el autor de la llamada debe liberar la cadena mediante la función SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring).
Valor devuelto
Devuelve un código de error COM estándar si se produce un error o uno de los siguientes:
| Código devuelto | Descripción |
|---|---|
| S_OK | El parámetro pbstrDescription contiene un puntero BSTR válido. |
| WIA_STATUS_NOT_HANDLED | El valor del parámetro hrStatus es desconocido para la extensión y no hay ninguna descripción disponible. |
Comentarios
Para que una aplicación llame a IWiaErrorHandler::GetStatusDescription, la aplicación debe llamar primero a IWiaItem2::GetExtension para recibir un puntero de interfaz a la extensión de control de errores. Una aplicación debe pasar "ErrorHandler" como bstrName y IID_IWiaErrorHandler como riidExtensionInterface. Una aplicación debe pasar 0 como lFlags para garantizar la compatibilidad ascendente.
La implementación de IWiaErrorHandler::GetStatusDescription debe devolver S_OK para todos los códigos de estado del dispositivo (hrStatus) que la implementación de IWiaErrorHandler::ReportStatus controla y WIA_STATUS_NOT_HANDLED para las que IWiaErrorHandler::ReportStatus no controla.
Requisitos
| Requisito | Value |
|---|---|
| Plataforma de destino | Escritorio |
| Encabezado | wia_lh.h (incluya Wia_lh.h) |