Skip to main content

XGameUiTextEntryGetState

Obtiene el estado actual del teclado virtual abierto.

Sintaxis

Parámetros

handle   _In_
Tipo: XGameUiTextEntryHandle
Identificador del teclado virtual abierto. changeType   _Out_
Tipo: XGameUiTextEntryChangeTypeFlags*
Describe si el texto ha cambiado o si el teclado virtual se ha descartado desde la última vez que el juego llamó a XGameUiTextEntryGetState. Si el tipo de cambio indica que el teclado virtual se ha descartado, el juego debe llamar a XGameUiTextEntryClose una vez que haya terminado de procesar los cambios de texto. cursorIndex   _Out_opt_
Tipo: uint32_t*
Índice de bytes del cursor con respecto al carácter inicial. imeClauseStartIndex   _Out_opt_
Tipo: uint32_t*
Índice de bytes inicial de la cláusula de IME que podría reemplazarse por un candidato de IME. Este índice estará antes del índice del cursor. Si no se usa IME, este valor será cero. imeClauseEndIndex   _Out_opt_
Tipo: uint32_t*
Índice de bytes final de la cláusula de IME que podría reemplazarse por un candidato de IME. Este índice estará después del índice del cursor. Si no se usa IME, este valor será cero. bufferSize   _In_
Tipo: uint32_t
Tamaño en bytes del búfer proporcionado por el juego que recibirá el texto del teclado virtual. buffer   _Out_
Tipo: char*
Texto completo escrito en el teclado virtual como una cadena de caracteres terminada en NULL. Una nueva línea se representará como ‘\n’.

Valor devuelto

Tipo: HRESULT HRESULT de éxito o código de error. Para ver una lista de códigos de error, consulte Códigos de error.

Comentarios

Es necesario llamar a esta función al menos una vez por fotograma para obtener los últimos cambios del teclado virtual. Si el teclado se descarta más adelante, la función se devolverá correctamente; sin embargo, el tipo de cambio incluirá KeyboardDismissed.

Requisitos

Encabezado: XGameUI.h Biblioteca: xgameruntime.lib Plataformas compatibles: Windows, consolas de la familia XBOX One y consolas XBOX Series

Consulte también

XGameUI
XGameUiTextEntryOpen XGameUiTextEntryClose
Última modificación el 28 de agosto de 2026