Skip to main content

XGameUiTextEntryGetState

Obtém o estado atual do teclado virtual aberto.

Sintaxe

Parâmetros

handle   _In_
Tipo: XGameUiTextEntryHandle
Identificador do teclado virtual aberto. changeType   _Out_
Tipo: XGameUiTextEntryChangeTypeFlags*
Descreve se o texto foi alterado ou se o teclado virtual foi fechado desde a última vez que o jogo chamou XGameUiTextEntryGetState. Se o tipo de alteração indicar que o teclado virtual foi fechado, o jogo deverá chamar XGameUiTextEntryClose depois de terminar de tratar as alterações de texto. cursorIndex   _Out_opt_
Tipo: uint32_t*
Índice de byte do cursor em relação ao caractere inicial. imeClauseStartIndex   _Out_opt_
Tipo: uint32_t*
Índice de byte inicial da cláusula do IME que pode ser substituída por um candidato do IME. Ele será anterior ao índice do cursor. Se o IME não estiver em uso, esse valor será zero. imeClauseEndIndex   _Out_opt_
Tipo: uint32_t*
Índice de byte final da cláusula do IME que pode ser substituída por um candidato do IME. Ele será posterior ao índice do cursor. Se o IME não estiver em uso, esse valor será zero. bufferSize   _In_
Tipo: uint32_t
Tamanho, em bytes, do buffer fornecido pelo jogo que receberá o texto do teclado virtual. buffer   _Out_
Tipo: char*
Texto completo inserido no teclado virtual como uma cadeia de caracteres terminada em nulo. A nova linha será representada como ‘\n’.

Valor retornado

Tipo: HRESULT Código HRESULT de êxito ou erro. Para obter uma lista de códigos de erro, consulte Códigos de erro.

Comentários

Essa função precisa ser chamada pelo menos uma vez por quadro para obter as alterações mais recentes do teclado virtual. Se o teclado for fechado posteriormente, a função retornará com êxito; no entanto, o tipo de alteração incluirá KeyboardDismissed.

Requisitos

Cabeçalho: XGameUI.h Biblioteca: xgameruntime.lib Plataformas compatíveis: Windows, consoles da família XBOX One e consoles XBOX Series

Confira também

XGameUI
XGameUiTextEntryOpen XGameUiTextEntryClose
Last modified on October 6, 2026