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

Obtém o estado atual do teclado virtual aberto.

## Sintaxe

```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 do teclado virtual aberto.

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

| Código de retorno | Descrição |
| - | - |
| S\_OK | A operação foi bem-sucedida. |
| E\_GAMEUI\_TEXTENTRY\_NOT\_SHOWN | O XGameUiTextEntryHandle não é válido, provavelmente porque você precisa chamar XGameUiTextEntryOpen. |

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


## Related topics

- [XGameUiTextEntryGetState](/reference/system/xgameui/functions/xgameuitextentrygetstate.md)
- [XGameUiTextEntryChangeTypeFlags](/reference/system/xgameui/enums/xgameuitextentrychangetypeflags.md)