> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XtfGetErrorText

> XtfGetErrorText

# XtfGetErrorText

Obtient un message d'erreur convivial et un texte d'action utilisateur pour le `HRESULT` spécifié.

<a id="syntaxSection" />

## Syntaxe

```cpp theme={null}
HRESULT XtfGetErrorText(
         HRESULT HResult,
         PWSTR *errorMessageBuffer,
         UINT32 *errorMessageBufferLength,
         PWSTR *userActionTextBuffer,
         UINT32 *userActionTextBufferLength
)  
```

<a id="parametersSection" />

### Paramètres

*HResult*\
Type : HRESULT

\[in] `HRESULT` pour lequel rechercher le message d'erreur et le texte d'action utilisateur.

*errorMessageBuffer*\
Type : PWSTR\*

\[out] Pointeur vers la mémoire tampon qui reçoit le message d'erreur sous forme de chaîne terminée par un caractère null. Pour déterminer la longueur de mémoire tampon requise, définissez ce paramètre sur `nullptr` et le paramètre *errorMessageBufferLength* sur 0. Lors de l'appel, *errorMessageBufferLength* est défini sur la longueur de la mémoire tampon requise en WCHARs, caractère null de fin compris.

*errorMessageBufferLength*\
Type : UINT32\*

\[in, out] En entrée, longueur de la mémoire tampon du message d'erreur en WCHARs. La longueur de la mémoire tampon doit inclure de la place pour un caractère null de fin. En sortie, longueur requise de **errorMessageBuffer** en WCHARs

*userActionTextBuffer*\
Type : PWSTR\*

\[out] Pointeur vers la mémoire tampon qui reçoit le texte d'action utilisateur sous forme de chaîne terminée par un caractère null. Pour déterminer la longueur de mémoire tampon requise, définissez ce paramètre sur `nullptr` et le paramètre *userActionTextBufferLength* sur 0. Lors de l'appel, *userActionTextBufferLength* est défini sur la longueur de la mémoire tampon requise en WCHARs, caractère null de fin compris.

*userActionTextBufferLength*\
Type : UINT32\*

\[in, out] Longueur de la mémoire tampon du texte d'action utilisateur en WCHARs. La longueur de la mémoire tampon doit inclure de la place pour un caractère null de fin.

<a id="retvalSection" />

### Valeur de retour

Type : HRESULT

Retourne `S_OK` en cas de réussite ; sinon, retourne un code d'erreur HRESULT.

Si `S_OK` est retourné, la fonction a réussi. `errorMessageBuffer` et `userActionTextBuffer` sont respectivement définis sur le message d'erreur et le texte d'action utilisateur pour le `HRESULT` spécifié.

Si `HRESULT_FROM_WIN32(ERROR_MORE_DATA)` est retourné, la mémoire tampon fournie pour `errorMessageBuffer` ou `userActionTextBuffer` n'était pas assez grande. `errorMessageBufferLength` et `userActionTextBufferLength` sont respectivement définis sur les longueurs de mémoire tampon requises pour le message d'erreur et le texte d'action utilisateur du `HRESULT` spécifié.

Si un autre code HRESULT est retourné, une erreur inattendue s'est produite.

<a id="remarksSection" />

## Remarques

Si le `HRESULT` passé à `XtfGetErrorText` n'est pas un code d'erreur XBOX Tools Framework (XTF) reconnu, `errorMessageBuffer` est défini sur "Unspecified error". Vous pouvez utiliser ce résultat pour vérifier si le `HRESULT` spécifié est un code d'erreur XTF reconnu. Pour plus d'informations sur les codes d'erreur XTF reconnus, consultez [Erreurs de transport XTF (rubrique sous NDA)](/fr/tools/tools-console/commandlinetools/xtf-transport-errors).

<a id="requirementsSection" />

## Configuration requise

**En-tête :** xtfapi.h

**Bibliothèque :** XtfApi.lib

**Plateformes prises en charge :** Windows (pour les outils de console XBOX)

<a id="seealsoSection" />

## Voir aussi

[XtfConsoleControl](/fr/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members)\
[Référence de l'API native XBOX Tools Framework](/fr/reference/tools/xtf/atoc-xtf-native)


## Related topics

- [XtfGetErrorText](/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortext-xtfconsolecontrol-xbox-microsoft-m.md)
- [XtfGetErrorTextA](/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortexta.md)