Skip to main content

XGameUiShowTextEntryAsync

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

Sintaxe

Parâmetros

async _In_
Tipo: XAsyncBlock*
Um ponteiro para o XAsyncBlock que é passado para XAsyncRun. titleText _In_opt_z_
Tipo: char*
O texto do título da interface do usuário de entrada de texto. descriptionText _In_opt_z_
Tipo: char*
O texto de descrição da interface do usuário de entrada de texto. defaultText _In_opt_z_
Tipo: char*
Texto padrão que é preenchido inicialmente na interface do usuário de entrada de texto. inputScope _In_
Tipo: 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_
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 e 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).

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
Suporte ao teclado virtual XGameUIShowTextEntryResult
XGameUIShowTextEntryResultSize
Ciclo de vida do jogo XBOX (tópico sob NDA)
Last modified on October 6, 2026