IWiaErrorHandler ::GetStatusDescription, méthode (wia_lh.h)
L’interface utilisateur système appelle la méthode GetStatusDescription pour fournir à l’utilisateur des informations supplémentaires sur une erreur, si l’utilisateur demande ces informations. Cette méthode est implémentée par l’extension d’interface utilisateur d’un pilote.
Syntaxe
HRESULT GetStatusDescription(
[in] LONG lFlags,
[in] IWiaItem2 *pWiaItem2,
[in] HRESULT hrStatus,
[out] BSTR *pbstrDescription
);
Paramètres
[in] lFlags
Actuellement inutilisé. Doit être défini sur zéro.
[in] pWiaItem2
Pointeur vers l’élément IWiaItem2 transféré.
[in] hrStatus
Variable HRESULT qui contient le code d’état reçu par la méthode de transfert WIA, par exemple la IWiaDataCallback ::BandedDataCallback.
[out] pbstrDescription
Pointeur vers une BSTR qui reçoit une description de l’état ou de l’erreur rencontrée pendant le transfert. Ce paramètre ne peut pas être NULL. Le pilote doit allouer la chaîne à l’aide de la fonctionSysAllocStringet l’appelant doit libérer la chaîne à l’aide de la fonction SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring).
Valeur de retour
Retourne un code d’erreur COM standard si une erreur se produit ou l’une des opérations suivantes :
| Retourner le code | Description |
|---|---|
| S_OK | Le paramètre pbstrDescription contient un pointeur BSTR valide. |
| WIA_STATUS_NOT_HANDLED | La valeur dans le paramètre hrStatus est inconnue de l’extension et aucune description n’est disponible. |
Remarques
Pour qu’une application appelle IWiaErrorHandler ::GetStatusDescription, l’application doit appeler IWiaItem2 ::GetExtension d’abord pour recevoir un pointeur d’interface vers l’extension de gestion des erreurs. Une application doit passer « ErrorHandler » en tant que bstrName et IID_IWiaErrorHandler en tant que riidExtensionInterface. Une application doit passer 0 en tant que lFlags pour garantir la compatibilité vers le haut.
L’implémentation de IWiaErrorHandler ::GetStatusDescription doit retourner S_OK pour tous les codes d’état de l’appareil (hrStatus) que l’implémentation de IWiaErrorHandler ::ReportStatus handles, et WIA_STATUS_NOT_HANDLED pour ceux qui IWiaErrorHandler ::ReportStatus ne gère pas.
Exigences
| Exigence | Valeur |
|---|---|
| plateforme cible | Bureau |
| d’en-tête | wia_lh.h (inclure Wia_lh.h) |