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

# XtfGetErrorText

> XtfGetErrorText

# XtfGetErrorText

Obtiene un mensaje de error descriptivo y el texto de acción del usuario para el `HRESULT` especificado.

## Sintaxis

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

### Parámetros

*HResult*\
Tipo: HRESULT

\[in] El `HRESULT` para el que se buscan el mensaje de error y el texto de acción del usuario.

*errorMessageBuffer*\
Tipo: PWSTR\*

\[out] Un puntero al búfer que recibe el mensaje de error como una cadena terminada en null. Para determinar la longitud de búfer necesaria, establezca este parámetro en `nullptr` y el parámetro *errorMessageBufferLength* en 0. Tras la invocación, *errorMessageBufferLength* se establece en la longitud del búfer necesario en WCHAR, incluido el carácter null de terminación.

*errorMessageBufferLength*\
Tipo: UINT32\*

\[in, out] En la entrada, la longitud del búfer del mensaje de error en WCHAR. La longitud del búfer debe incluir espacio para un carácter null de terminación. En la salida, la longitud necesaria de **errorMessageBuffer** en WCHAR

*userActionTextBuffer*\
Tipo: PWSTR\*

\[out] Un puntero al búfer que recibe el texto de acción del usuario como una cadena terminada en null. Para determinar la longitud de búfer necesaria, establezca este parámetro en `nullptr` y el parámetro *userActionTextBufferLength* en 0. Tras la invocación, *userActionTextBufferLength* se establece en la longitud del búfer necesario en WCHAR, incluido el carácter null de terminación.

*userActionTextBufferLength*\
Tipo: UINT32\*

\[in, out] La longitud del búfer del texto de acción del usuario en WCHAR. La longitud del búfer debe incluir espacio para un carácter null de terminación.

### Valor devuelto

Tipo: HRESULT

Devuelve `S_OK` si se ejecuta correctamente; de lo contrario, devuelve un código de error HRESULT.

Si se devuelve `S_OK`, la función se ejecutó correctamente. `errorMessageBuffer` y `userActionTextBuffer` se establecen en el mensaje de error y el texto de acción del usuario, respectivamente, para el `HRESULT` especificado.

Si se devuelve `HRESULT_FROM_WIN32(ERROR_MORE_DATA)`, el búfer proporcionado para `errorMessageBuffer` o `userActionTextBuffer` no era lo suficientemente grande. `errorMessageBufferLength` y `userActionTextBufferLength` se establecen en las longitudes de búfer necesarias para el mensaje de error y el texto de acción del usuario, respectivamente, para el `HRESULT` especificado.

Si se devuelve cualquier otro código HRESULT, se produjo un error inesperado.

## Comentarios

Si el `HRESULT` pasado a `XtfGetErrorText` no es un código de error reconocido de XBOX Tools Framework (XTF), `errorMessageBuffer` se establece en "Unspecified error". Puede usar este resultado para comprobar si el `HRESULT` especificado es un código de error XTF reconocido. Para obtener más información sobre los códigos de error XTF reconocidos, consulte [Errores de transporte de XTF (tema NDA)](https://docs.xbox.com/es/tools/tools-console/commandlinetools/xtf-transport-errors.md).

## Requisitos

**Encabezado:** xtfapi.h

**Biblioteca:** XtfApi.lib

**Plataformas compatibles:** Windows (para herramientas de consola XBOX)

## Consulte también

[XtfConsoleControl](https://docs.xbox.com/es/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members.md)\
[Referencia de la API nativa de XBOX Tools Framework](https://docs.xbox.com/es/reference/tools/xtf/atoc-xtf-native.md)


## Related topics

- [XtfGetErrorTextA](https://docs.xbox.com/es/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortexta.md)
- [API de Xtf adicionales (contenido de la API)](https://docs.xbox.com/es/reference/tools/xtf/xtfapi/atoc-xtfapi.md)
- [PartyTextToSpeechProfile::GetGender](https://docs.xbox.com/es/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getgender.md)
- [PartyTextToSpeechProfile::GetIdentifier](https://docs.xbox.com/es/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getidentifier.md)
- [PartyTextToSpeechProfile::GetName](https://docs.xbox.com/es/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getname.md)