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'elementoIWiaItem2 da trasferire.
[in] hrStatus
Variabile HRESULT contenente il codice di stato ricevuto dal metodo di trasferimento WIA, ad esempio la 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 funzioneSysAllocStringe 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. |
Osservazioni
Affinché un'applicazione chiami IWiaErrorHandler::GetStatusDescription, l'applicazione deve chiamare IWiaItem2::GetExtension prima di ricevere un puntatore dell'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 di handle IWiaErrorHandler::ReportStatus e WIA_STATUS_NOT_HANDLED per quelli che IWiaErrorHandler::ReportStatus non gestisce.
Fabbisogno
| Requisito | Valore |
|---|---|
| piattaforma di destinazione | Desktop |
| intestazione | wia_lh.h (includere Wia_lh.h) |