Partager via


Méthode IWiaMiniDrv ::d rvGetDeviceErrorStr (wiamindr_lh.h)

La méthode IWiaMiniDrv ::d rvGetDeviceErrorStr mappe un code d’erreur à une chaîne Unicode qui décrit l’erreur.

Syntaxe

HRESULT drvGetDeviceErrorStr(
  LONG     __MIDL__IWiaMiniDrv0039,
  LONG     __MIDL__IWiaMiniDrv0040,
  LPOLESTR *__MIDL__IWiaMiniDrv0041,
  LONG     *__MIDL__IWiaMiniDrv0042
);

Paramètres

__MIDL__IWiaMiniDrv0039

lDevErrVal [in]

Spécifie la valeur d’erreur d’appareil à mapper à une chaîne. La valeur zéro indique qu’aucune erreur ne s’est produite.

__MIDL__IWiaMiniDrv0040

lFlags [in]

Réservé.

__MIDL__IWiaMiniDrv0041

plDevErr [out]

Pointe vers un emplacement de mémoire qui recevra un code status pour cette méthode. Si cette méthode retourne S_OK, la valeur stockée est égale à zéro. Sinon, un code d’erreur spécifique au minidriver est stocké à l’emplacement indiqué par ce paramètre.

__MIDL__IWiaMiniDrv0042

ppszDevErrStr [out, facultatif]

Pointe vers un emplacement de mémoire qui recevra l’adresse d’une chaîne décrivant l’erreur.

Valeur retournée

En cas de réussite, la méthode doit retourner S_OK et effacer la valeur d’erreur de l’appareil pointée par plDevErr. Si le minidriver n’implémente pas entièrement cette méthode, la méthode doit retourner E_NOTIMPL. Si le minidriver ne reconnaît pas la valeur d’erreur passée à cette méthode, la méthode doit retourner E_INVALIDARG. Si la méthode échoue, elle doit retourner un code d’erreur COM standard et placer une valeur de code d’erreur spécifique au minidriver dans la mémoire pointée par plDevErr.

Remarques

Pour obtenir une chaîne d’erreur qui décrit une valeur d’erreur générée par minidriver spécifique à l’appareil, le service WIA appelle la méthode IWiaMiniDrv ::d rvGetDeviceErrorStr . En réponse à cet appel, le minidriver doit utiliser CoTaskMemAlloc pour allouer de la mémoire qui contiendra une chaîne Unicode localisée correspondant au code d’erreur passé au minidriver. Le service WIA (ou une application) libère la mémoire. Il est probable qu’une application affiche la chaîne. Elle doit donc être significative pour un utilisateur final. La chaîne doit être chargée à partir d’un fichier de ressources, afin qu’elle puisse être localisée dans diverses langues.

Configuration requise

Condition requise Valeur
Plateforme cible Desktop (Expérience utilisateur)
En-tête wiamindr_lh.h (incluez Wiamindr.h)