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

# XGameUiTextEntryGetState

> XGameUiTextEntryGetState

# XGameUiTextEntryGetState

Obtiene el estado actual del teclado virtual abierto.

## Sintaxis

```cpp theme={null}
HRESULT XGameUiTextEntryGetState(  
         XGameUiTextEntryHandle handle,
         XGameUiTextEntryChangeTypeFlags* changeType,
         uint32_t* cursorIndex,
         uint32_t* imeClauseStartIndex,
         uint32_t* imeClauseEndIndex,
         uint32_t bufferSize,
         char* buffer
)  
```

### Parámetros

*handle*   \_In\_\
Tipo: XGameUiTextEntryHandle

Identificador del teclado virtual abierto.

*changeType*   \_Out\_\
Tipo: [XGameUiTextEntryChangeTypeFlags\*](/reference/system/xgameui/enums/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](/reference/system/xgameui/functions/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](/reference/errorcodes).

| Código devuelto                  | Descripción                                                                                          |
| -------------------------------- | ---------------------------------------------------------------------------------------------------- |
| S\_OK                            | La operación se realizó correctamente.                                                               |
| E\_GAMEUI\_TEXTENTRY\_NOT\_SHOWN | El XGameUiTextEntryHandle no es válido, probablemente porque necesita llamar a XGameUiTextEntryOpen. |

## 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](/reference/system/xgameui/xgameui_members)\
[XGameUiTextEntryOpen](/reference/system/xgameui/functions/xgameuitextentryopen)
[XGameUiTextEntryClose](/reference/system/xgameui/functions/xgameuitextentryclose)


## Related topics

- [XGameUiTextEntryChangeTypeFlags](/es/reference/system/xgameui/enums/xgameuitextentrychangetypeflags.md)
- [XGameUI](/es/reference/system/xgameui/xgameui_members.md)
- [XGameUiTextEntryGetExtents](/es/reference/system/xgameui/functions/xgameuitextentrygetextents.md)
- [XGameUiTextEntryExtents](/es/reference/system/xgameui/structs/xgameuitextentryextents.md)
- [XGameUiSetTextEntryUiResponse](/es/reference/system/xgameui/functions/xgameuisettextentryuiresponse.md)