> ## 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-CA/reference/system/xgameui/enums/xgameuitextentrychangetypeflags)

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

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

Index d'octet du curseur par rapport au caractère de départ.

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

Index d'octet de début de la clause IME qui pourrait ê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 d'octet de fin de la clause IME qui pourrait ê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 nul. 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-CA/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 image pour obtenir les dernières modifications du clavier virtuel.
Si le clavier est fermé par la suite, la fonction retourne un résultat de réussite; toutefois, le type de changement
inclura 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-CA/reference/system/xgameui/xgameui_members)\
[XGameUiTextEntryOpen](/fr-CA/reference/system/xgameui/functions/xgameuitextentryopen)
[XGameUiTextEntryClose](/fr-CA/reference/system/xgameui/functions/xgameuitextentryclose)


## Related topics

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