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

Obtient l'état actuel du clavier virtuel ouvert.

## Syntaxe

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

### Paramètres

*handle*   \_In\_\
Type : XGameUiTextEntryHandle

Handle du clavier virtuel ouvert.

*changeType*   \_Out\_\
Type : [XGameUiTextEntryChangeTypeFlags\*](/fr/reference/system/xgameui/enums/xgameuitextentrychangetypeflags)

Indique si le texte a changé ou si le clavier virtuel a été fermé depuis le dernier appel
de *XGameUiTextEntryGetState* par le jeu. Si le type de modification indique que le clavier
virtuel a été fermé, le jeu doit appeler [XGameUiTextEntryClose](/fr/reference/system/xgameui/functions/xgameuitextentryclose)
une fois qu'il a terminé de traiter les modifications du texte.

*cursorIndex*   \_Out\_opt\_\
Type : uint32\_t\*

Index en octets du curseur par rapport au caractère de début.

*imeClauseStartIndex*   \_Out\_opt\_\
Type : uint32\_t\*

Index en octets du début de la clause IME susceptible d'être remplacée par un candidat IME. Il se situe
avant l'index du curseur. Si l'IME n'est pas utilisé, cette valeur est zéro.

*imeClauseEndIndex*   \_Out\_opt\_\
Type : uint32\_t\*

Index en octets de fin de la clause IME susceptible d'être remplacée par un candidat IME. Il se situe
après l'index du curseur. Si l'IME n'est pas utilisé, cette valeur est zéro.

*bufferSize*   \_In\_\
Type : uint32\_t

Taille en octets de la mémoire tampon fournie par le jeu qui recevra le texte du clavier virtuel.

*buffer*   \_Out\_\
Type : char\*

Texte complet saisi dans le clavier virtuel, sous forme de chaîne de caractères terminée par un caractère null. Les sauts de ligne sont
représentés par '\n'.

### Valeur de retour

Type : HRESULT

Code de réussite ou d'erreur HRESULT. Pour obtenir la liste des codes d'erreur, consultez [Codes d'erreur](/fr/reference/errorcodes).

| Code de retour | Description |
| - | - |
| S\_OK | L'opération a réussi. |
| E\_GAMEUI\_TEXTENTRY\_NOT\_SHOWN | Le XGameUiTextEntryHandle n'est pas valide, probablement parce que vous devez appeler XGameUiTextEntryOpen. |

## Remarques

Cette fonction doit être appelée au moins une fois par frame pour obtenir les dernières modifications du clavier virtuel.
Si le clavier est ensuite fermé, la fonction réussit ; toutefois, le type de modification
inclut KeyboardDismissed.

## Configuration requise

**En-tête :** XGameUI.h

**Bibliothèque :** xgameruntime.lib

**Plateformes prises en charge :** Windows, consoles de la famille XBOX One et consoles XBOX Series

## Voir aussi

[XGameUI](/fr/reference/system/xgameui/xgameui_members)\
[XGameUiTextEntryOpen](/fr/reference/system/xgameui/functions/xgameuitextentryopen)
[XGameUiTextEntryClose](/fr/reference/system/xgameui/functions/xgameuitextentryclose)


## Related topics

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