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

# XGameUiShowTextEntryAsync

> XGameUiShowTextEntryAsync

# XGameUiShowTextEntryAsync

Exibe uma interface do usuário de entrada de texto para que um usuário insira informações.

## Sintaxe

```cpp theme={null}
HRESULT XGameUiShowTextEntryAsync(  
         XAsyncBlock* async,  
         const char* titleText,  
         const char* descriptionText,  
         const char* defaultText,  
         XGameUiTextEntryInputScope inputScope,  
         uint32_t maxTextLength  
)  
```

### Parâmetros

*async*   \_In\_<br />Tipo: [XAsyncBlock\*](/pt-BR/reference/system/xasync/structs/xasyncblock)

Um ponteiro para o [XAsyncBlock](/pt-BR/reference/system/xasync/structs/xasyncblock) que é passado para [XAsyncRun](/pt-BR/reference/system/xasync/functions/xasyncrun).

*titleText*   \_In\_opt\_z\_<br />Tipo: char\*

O texto do título da interface do usuário de entrada de texto.

*descriptionText*   \_In\_opt\_z\_<br />Tipo: char\*

O texto de descrição da interface do usuário de entrada de texto.

*defaultText*   \_In\_opt\_z\_<br />Tipo: char\*

Texto padrão que é preenchido inicialmente na interface do usuário de entrada de texto.

*inputScope*   \_In\_<br />Tipo: [XGameUiTextEntryInputScope](/pt-BR/reference/system/xgameui/enums/xgameuitextentryinputscope)

Especifica o escopo de entrada da entrada de texto, indicando o tipo de informação permitido. Esse escopo fornece uma dica sobre qual texto o jogo pode desejar. O jogo ainda precisará validar o texto que receber do teclado.

*maxTextLength*   \_In\_<br />Tipo: uint32\_t

O número máximo de caracteres que o usuário pode inserir na interface do usuário de entrada de texto. No console, o número máximo de caracteres é 1024. No PC, não há limitação. Se o valor 0 for passado, ele será tratado como um comprimento máximo de 1024 caracteres. Além disso, se *inputScope* for XGameUiTextEntryInputScope::Password, o comprimento máximo será sempre 1024 e o valor de *maxTextLength* será ignorado.

### Valor retornado

Tipo: HRESULT

Código de êxito ou de erro HRESULT da chamada assíncrona.

Para obter o resultado, chame [XGameUiShowTextEntryResultSize](/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryresultsize) e [XGameUiShowTextEntryResult](/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryresult) dentro do retorno de chamada do *AsyncBlock* ou após a conclusão do *AsyncBlock*.

## Comentários

Nos consoles, isso fornecerá um campo de entrada de texto e um teclado virtual na tela (OSK). No Windows, isso fornecerá uma nova janela com um campo de entrada de texto. Um teclado virtual só aparecerá no Windows se o usuário estiver configurado para usar um teclado na tela (por exemplo, no modo tablet) em vez de um teclado físico.

Solicitar uma interface do usuário fará com que seu jogo entre no *modo restrito*. No modo restrito, seu título receberá menos recursos do sistema enquanto estiver em segundo plano em relação à interface do usuário solicitada. Para saber mais sobre o modo restrito e outros modos operacionais do seu título, leia [Ciclo de vida do jogo XBOX (tópico sob NDA)](/pt-BR/build/console-features/console-workflows/xbox-game-life-cycle).

## Requisitos

**Cabeçalho:** XGameUI.h

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** Windows, Steam Deck, consoles da família XBOX One e consoles XBOX Series

## Confira também

[XGameUI](/pt-BR/reference/system/xgameui/xgameui_members)<br />[Suporte ao teclado virtual](/pt-BR/build/core-features/common/input/overviews/virtualkeyboardsupport) [XGameUIShowTextEntryResult](/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryresult)<br />[XGameUIShowTextEntryResultSize](/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryresultsize)<br />[Ciclo de vida do jogo XBOX (tópico sob NDA)](/pt-BR/build/console-features/console-workflows/xbox-game-life-cycle)


## Related topics

- [XGameUiShowTextEntryAsync](/reference/system/xgameui/functions/xgameuishowtextentryasync.md)
- [XGameUiShowTextEntryResult](/reference/system/xgameui/functions/xgameuishowtextentryresult.md)
- [XGameUiShowTextEntryResultSize](/reference/system/xgameui/functions/xgameuishowtextentryresultsize.md)
- [XGameUiShowTextEntryUiCallback](/reference/system/xgameui/functions/xgameuishowtextentryuicallback.md)