Método IWiaErrorHandler::GetStatusDescription (wia_lh.h)
A interface do usuário do sistema chama o método GetStatusDescription para fornecer ao usuário informações extras sobre um erro, se o usuário solicitar essas informações. Esse método é implementado pela extensão de interface do usuário de um driver.
Sintaxe
HRESULT GetStatusDescription(
[in] LONG lFlags,
[in] IWiaItem2 *pWiaItem2,
[in] HRESULT hrStatus,
[out] BSTR *pbstrDescription
);
Parâmetros
[in] lFlags
Atualmente não utilizado. Deve ser definido como zero.
[in] pWiaItem2
Ponteiro para o item IWiaItem2 que está sendo transferido.
[in] hrStatus
Variável HRESULT que contém o código status recebido pelo método de transferência WIA, por exemplo, IWiaDataCallback::BandedDataCallback.
[out] pbstrDescription
Ponteiro para um BSTR que recebe uma descrição do status ou erro encontrado durante a transferência. Esse parâmetro não pode ser NULL. O driver deve alocar a cadeia de caracteres usando a função SysAllocString e o chamador deve liberar a cadeia de caracteres usando a função SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring).
Retornar valor
Retorna um código de erro COM padrão se ocorrer um erro ou um dos seguintes:
| Código de retorno | Descrição |
|---|---|
| S_OK | O parâmetro pbstrDescription contém um ponteiro BSTR válido. |
| WIA_STATUS_NOT_HANDLED | O valor no parâmetro hrStatus é desconhecido para a extensão e nenhuma descrição está disponível. |
Comentários
Para que um aplicativo chame IWiaErrorHandler::GetStatusDescription, o aplicativo deve chamar IWiaItem2::GetExtension primeiro para receber um ponteiro de interface para a extensão de tratamento de erros. Um aplicativo deve passar "ErrorHandler" como bstrName e IID_IWiaErrorHandler como riidExtensionInterface. Um aplicativo deve passar 0 como lFlags para garantir a compatibilidade para cima.
A implementação de IWiaErrorHandler::GetStatusDescription deve retornar S_OK para todos os códigos de status do dispositivo (hrStatus) que a implementação de IWiaErrorHandler::ReportStatus manipula e WIA_STATUS_NOT_HANDLED para aqueles que IWiaErrorHandler::ReportStatus não manipula.
Requisitos
| Requisito | Valor |
|---|---|
| Plataforma de Destino | Área de Trabalho |
| Cabeçalho | wia_lh.h (inclua Wia_lh.h) |