Méthode IBackgroundCopyError ::GetErrorContextDescription (bits.h)

Article
02/28/2024

Récupère la description du contexte dans lequel l’erreur s’est produite.

Syntaxe

HRESULT GetErrorContextDescription(
  [in]  DWORD  LanguageId,
  [out] LPWSTR *pContextDescription
);

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] pContextDescription

Chaîne terminée par null qui contient la description du contexte dans lequel l’erreur s’est produite. Appelez la fonction CoTaskMemFree pour libérer ppContextDescription 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 du contexte a été récupéré 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.

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 ::GetErrorDescription

IBackgroundCopyError ::GetFile