IWiaErrorHandler::GetStatusDescription-Methode (wia_lh.h)
Die Systembenutzeroberfläche ruft die GetStatusDescription-Methode auf, um dem Benutzer zusätzliche Informationen zu einem Fehler bereitzustellen, wenn der Benutzer diese Informationen anfordert. Diese Methode wird durch die Benutzeroberflächenerweiterung eines Treibers implementiert.
Syntax
HRESULT GetStatusDescription(
[in] LONG lFlags,
[in] IWiaItem2 *pWiaItem2,
[in] HRESULT hrStatus,
[out] BSTR *pbstrDescription
);
Parameter
[in] lFlags
Derzeit nicht verwendet. Sollte auf Null festgelegt werden.
[in] pWiaItem2
Zeiger auf das IWiaItem2-Element , das übertragen wird.
[in] hrStatus
HRESULT-Variable, die den von der WIA-Übertragungsmethode empfangenen status Code enthält, z. B. IWiaDataCallback::BandedDataCallback.
[out] pbstrDescription
Zeiger auf einen BSTR, der eine Beschreibung des status oder Fehlers empfängt, der während der Übertragung aufgetreten ist. Dieser Parameter darf nicht NULL sein. Der Treiber muss die Zeichenfolge mithilfe der SysAllocString-Funktion zuordnen, und der Aufrufer muss die Zeichenfolge mithilfe der SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring)-Funktion freigeben.
Rückgabewert
Gibt einen COM-Standardfehlercode zurück, wenn ein Fehler auftritt, oder einen der folgenden:
| Rückgabecode | BESCHREIBUNG |
|---|---|
| S_OK | Der pbstrDescription-Parameter enthält einen gültigen BSTR-Zeiger. |
| WIA_STATUS_NOT_HANDLED | Der Wert im hrStatus-Parameter ist für die Erweiterung unbekannt, und es ist keine Beschreibung verfügbar. |
Hinweise
Damit eine Anwendung IWiaErrorHandler::GetStatusDescription aufruft, muss die Anwendung zuerst IWiaItem2::GetExtension aufrufen, um einen Schnittstellenzeiger auf die Fehlerbehandlungserweiterung zu erhalten. Eine Anwendung muss "ErrorHandler" als bstrName und IID_IWiaErrorHandler als riidExtensionInterface übergeben. Eine Anwendung sollte 0 als lFlags übergeben, um die Kompatibilität nach oben zu gewährleisten.
Die Implementierung von IWiaErrorHandler::GetStatusDescription sollte S_OK für alle Geräte-status-Codes (hrStatus) zurückgeben, die von der Implementierung von IWiaErrorHandler::ReportStatus verarbeitet werden, und WIA_STATUS_NOT_HANDLED für diejenigen, die IWiaErrorHandler:ReportStatus nicht verarbeitet.
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform | Desktop |
| Kopfzeile | wia_lh.h (einschließlich Wia_lh.h) |