Metodo IWiaErrorHandler::GetStatusDescription (wia_lh.h)
L'interfaccia utente di sistema chiama il metodo GetStatusDescription per fornire all'utente informazioni aggiuntive su un errore, se l'utente richiede queste informazioni. Questo metodo viene implementato dall'estensione dell'interfaccia utente di un driver.
Sintassi
HRESULT GetStatusDescription(
[in] LONG lFlags,
[in] IWiaItem2 *pWiaItem2,
[in] HRESULT hrStatus,
[out] BSTR *pbstrDescription
);
Parametri
[in] lFlags
Attualmente inutilizzato. Deve essere impostato su zero.
[in] pWiaItem2
Puntatore all'elemento IWiaItem2 da trasferire.
[in] hrStatus
Variabile HRESULT che contiene il codice di stato ricevuto dal metodo di trasferimento WIA, ad esempio IWiaDataCallback::BandedDataCallback.
[out] pbstrDescription
Puntatore a un BSTR che riceve una descrizione dello stato o dell'errore rilevato durante il trasferimento. Questo parametro non può essere NULL. Il driver deve allocare la stringa usando la funzione SysAllocString e il chiamante deve liberare la stringa usando la funzione SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring).
Valore restituito
Restituisce un codice di errore COM standard se si verifica un errore o uno dei seguenti:
| Codice restituito | Descrizione |
|---|---|
| S_OK | Il parametro pbstrDescription contiene un puntatore BSTR valido. |
| WIA_STATUS_NOT_HANDLED | Il valore nel parametro hrStatus è sconosciuto all'estensione e non è disponibile alcuna descrizione. |
Commenti
Affinché un'applicazione chiami IWiaErrorHandler::GetStatusDescription, l'applicazione deve chiamare prima IWiaItem2::GetExtension per ricevere un puntatore di interfaccia all'estensione di gestione degli errori. Un'applicazione deve passare "ErrorHandler" come bstrName e IID_IWiaErrorHandler come riidExtensionInterface. Un'applicazione deve passare 0 come lFlags per garantire la compatibilità verso l'alto.
L'implementazione di IWiaErrorHandler::GetStatusDescription deve restituire S_OK per tutti i codici di stato del dispositivo (hrStatus) che l'implementazione degli handle IWiaErrorHandler::ReportStatus e WIA_STATUS_NOT_HANDLED per quelli non gestiti da IWiaErrorHandler::ReportStatus .
Requisiti
| Requisito | Valore |
|---|---|
| Piattaforma di destinazione | Desktop |
| Intestazione | wia_lh.h (includere Wia_lh.h) |