Méthode IWiaErrorHandler ::GetStatusDescription (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 (0).
[in] pWiaItem2
Pointeur vers l’élément IWiaItem2 en cours de transfert.
[in] hrStatus
Variable HRESULT qui contient le code status reçu par la méthode de transfert WIA, par exemple IWiaDataCallback ::BandedDataCallback.
[out] pbstrDescription
Pointeur vers un BSTR qui reçoit une description de la status 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 fonction SysAllocString et l’appelant doit libérer la chaîne à l’aide de la fonction SysFreeString](/windows/win32/api/oleauto/nf-oleauto-sysfreestring).
Valeur retournée
Retourne un code d’erreur COM standard si une erreur se produit, ou l’une des opérations suivantes :
| Code de retour | 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 d’abord appeler IWiaItem2 ::GetExtension 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 de status d’appareil (hrStatus) que l’implémentation de IWiaErrorHandler ::ReportStatus gère, et WIA_STATUS_NOT_HANDLED pour ceux que IWiaErrorHandler ::ReportStatus ne gère pas.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Plateforme cible | Desktop (Expérience utilisateur) |
| En-tête | wia_lh.h (include Wia_lh.h) |