> ## 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

Obtém uma mensagem de erro amigável e o texto de ação do usuário para o `HRESULT` especificado.

<a id="syntaxSection" />

## Sintaxe

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

<a id="parametersSection" />

### Parâmetros

*HResult*\
Tipo: HRESULT

\[in] O `HRESULT` para o qual pesquisar a mensagem de erro e o texto de ação do usuário.

*errorMessageBuffer*\
Tipo: PWSTR\*

\[out] Um ponteiro para o buffer que recebe a mensagem de erro como uma cadeia de caracteres terminada em nulo. Para determinar o comprimento de buffer necessário, defina esse parâmetro como `nullptr` e o parâmetro *errorMessageBufferLength* como 0. Após a invocação, *errorMessageBufferLength* é definido como o comprimento do buffer necessário em WCHARs, incluindo o caractere nulo de terminação.

*errorMessageBufferLength*\
Tipo: UINT32\*

\[in, out] Na entrada, o comprimento do buffer de mensagem de erro em WCHARs. O comprimento do buffer deve incluir espaço para um caractere nulo de terminação. Na saída, o comprimento necessário de **errorMessageBuffer** em WCHARs

*userActionTextBuffer*\
Tipo: PWSTR\*

\[out] Um ponteiro para o buffer que recebe o texto de ação do usuário como uma cadeia de caracteres terminada em nulo. Para determinar o comprimento de buffer necessário, defina esse parâmetro como `nullptr` e o parâmetro *userActionTextBufferLength* como 0. Após a invocação, *userActionTextBufferLength* é definido como o comprimento do buffer necessário em WCHARs, incluindo o caractere nulo de terminação.

*userActionTextBufferLength*\
Tipo: UINT32\*

\[in, out] O comprimento do buffer de texto de ação do usuário em WCHARs. O comprimento do buffer deve incluir espaço para um caractere nulo de terminação.

<a id="retvalSection" />

### Valor retornado

Tipo: HRESULT

Retorna `S_OK` se for bem-sucedido; caso contrário, retorna um código de erro HRESULT.

Se `S_OK` for retornado, a função foi bem-sucedida. `errorMessageBuffer` e `userActionTextBuffer` são definidos como a mensagem de erro e o texto de ação do usuário, respectivamente, para o `HRESULT` especificado.

Se `HRESULT_FROM_WIN32(ERROR_MORE_DATA)` for retornado, o buffer fornecido para `errorMessageBuffer` ou `userActionTextBuffer` não era grande o suficiente. `errorMessageBufferLength` e `userActionTextBufferLength` são definidos como os comprimentos de buffer necessários da mensagem de erro e do texto de ação do usuário, respectivamente, para o `HRESULT` especificado.

Se qualquer outro código HRESULT for retornado, ocorreu um erro inesperado.

<a id="remarksSection" />

## Comentários

Se o `HRESULT` passado para `XtfGetErrorText` não for um código de erro reconhecido do XBOX Tools Framework (XTF), `errorMessageBuffer` será definido como "Unspecified error". Você pode usar esse resultado para verificar se o `HRESULT` especificado é um código de erro do XTF reconhecido. Para obter mais informações sobre os códigos de erro do XTF reconhecidos, confira [Erros de transporte do XTF (tópico NDA)](/pt-BR/tools/tools-console/commandlinetools/xtf-transport-errors).

<a id="requirementsSection" />

## Requisitos

**Cabeçalho:** xtfapi.h

**Biblioteca:** XtfApi.lib

**Plataformas com suporte:** Windows (para ferramentas de console XBOX)

<a id="seealsoSection" />

## Confira também

[XtfConsoleControl](/pt-BR/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members)\
[Referência da API nativa do XBOX Tools Framework](/pt-BR/reference/tools/xtf/atoc-xtf-native)


## Related topics

- [XtfGetErrorTextA](/pt-BR/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortexta.md)
- [PartyTextToSpeechProfile::GetGender](/pt-BR/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getgender.md)
- [PartyTextToSpeechProfile::GetIdentifier](/pt-BR/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getidentifier.md)
- [PartyTextToSpeechProfile::GetName](/pt-BR/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/methods/partytexttospeechprofile_getname.md)
- [XtfGetAumid](/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m.md)