IWiaErrorHandler::GetStatusDescription-Methode (wia_lh.h)
Die System-UI ruft die GetStatusDescription Methode auf, um dem Benutzer zusätzliche Informationen zu einem Fehler bereitzustellen, wenn der Benutzer diese Informationen anfordert. Diese Methode wird von der Ui-Erweiterung 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 übertragen wird.
[in] hrStatus
HRESULT-Variable, die den Statuscode enthält, der von der WIA-Übertragungsmethode empfangen wird, z. B. die 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 kann nicht NULL-werden. Der Treiber muss die Zeichenfolge mithilfe der SysAllocString--Funktion zuweisen, und der Aufrufer muss die Zeichenfolge mit der funktion SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring) freigeben.
Rückgabewert
Gibt einen standardmäßigen COM-Fehlercode zurück, wenn ein Fehler auftritt, oder einer 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 der Erweiterung unbekannt, und es ist keine Beschreibung verfügbar. |
Bemerkungen
Damit eine Anwendung IWiaErrorHandler::GetStatusDescriptionaufruft, muss die Anwendung IWiaItem2::GetExtension zuerst aufrufen, um einen Schnittstellenzeiger auf die Fehlerbehandlungserweiterung zu empfangen. Eine Anwendung muss "ErrorHandler" als bstrName übergeben und IID_IWiaErrorHandler als riidExtensionInterface. Eine Anwendung sollte 0 als lFlags übergeben, um die Aufwärtskompatibilität sicherzustellen.
Die Implementierung von IWiaErrorHandler::GetStatusDescription sollte S_OK für alle Gerätestatuscodes (hrStatus) zurückgeben, die die Implementierung von IWiaErrorHandler::ReportStatus behandelt, und WIA_STATUS_NOT_HANDLED für diejenigen , die IWiaErrorHandler::ReportStatus nicht verarbeiten.
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform- | Desktop |
| Header- | wia_lh.h (einschließen Wia_lh.h) |