IBackgroundCopyError ::GetErrorDescription, méthode (bits.h)

  • Article

Récupère le texte d’erreur associé à l’erreur.

Syntaxe

HRESULT GetErrorDescription(
  [in]  DWORD  LanguageId,
  [out] LPWSTR *pErrorDescription
);

Paramètres

[in] LanguageId

Identifie les paramètres régionaux à utiliser pour générer la description. Pour créer l’identificateur de langue, utilisez la macro MAKELANGID . Par exemple, pour spécifier l’anglais américain, utilisez l’exemple de code suivant.

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

Pour récupérer l’identificateur de langue utilisateur par défaut du système, utilisez les appels suivants.

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

Chaîne terminée par null qui contient le texte d’erreur associé à l’erreur. Appelez la fonction CoTaskMemFree pour libérer ppErrorDescription lorsque vous avez terminé.

Valeur retournée

Cette méthode retourne les valeurs HRESULT suivantes, ainsi que d’autres.

Code de retour Description
S_OK
 Description de l’erreur a été récupérée avec succès.
E_OUTOFMEMORY
 La mémoire n'est pas suffisante pour terminer cette opération.
E_INVALIDARG
 Le paramètre LanguageId ne peut pas être 0.
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)
 Aucune chaîne n’est disponible pour les paramètres régionaux.

Remarques

Vous pouvez également appeler la méthode IBackgroundCopyManager ::GetErrorDescription pour récupérer le texte d’erreur associé à un code d’erreur.

Les descriptions des erreurs HTTP sont localisées.

Windows XP/2000 : Les descriptions des erreurs HTTP ne sont pas localisées.

Exemples

Consultez l’exemple de code dans la rubrique Gestion des erreurs .

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP
Serveur minimal pris en charge Windows Server 2003
Plateforme cible Windows
En-tête bits.h
Bibliothèque Bits.lib
DLL QmgrPrxy.dll

Voir aussi

IBackgroundCopyError ::GetError

IBackgroundCopyError ::GetErrorContextDescription

IBackgroundCopyError ::GetFile

IBackgroundCopyManager ::GetErrorDescription