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

# XGameUiShowTextEntryAsync

> XGameUiShowTextEntryAsync

# XGameUiShowTextEntryAsync

Affiche une interface utilisateur de saisie de texte permettant à un utilisateur d'entrer des informations.

## Syntaxe

```cpp theme={null}
HRESULT XGameUiShowTextEntryAsync(  
         XAsyncBlock* async,  
         const char* titleText,  
         const char* descriptionText,  
         const char* defaultText,  
         XGameUiTextEntryInputScope inputScope,  
         uint32_t maxTextLength  
)  
```

### Paramètres

*async*   \_In\_<br />Type : [XAsyncBlock\*](/fr/reference/system/xasync/structs/xasyncblock)

Pointeur vers le [XAsyncBlock](/fr/reference/system/xasync/structs/xasyncblock) qui est passé à [XAsyncRun](/fr/reference/system/xasync/functions/xasyncrun).

*titleText*   \_In\_opt\_z\_<br />Type : char\*

Texte du titre de l'interface utilisateur de saisie de texte.

*descriptionText*   \_In\_opt\_z\_<br />Type : char\*

Texte de description de l'interface utilisateur de saisie de texte.

*defaultText*   \_In\_opt\_z\_<br />Type : char\*

Texte par défaut initialement renseigné dans l'interface utilisateur de saisie de texte.

*inputScope*   \_In\_<br />Type : [XGameUiTextEntryInputScope](/fr/reference/system/xgameui/enums/xgameuitextentryinputscope)

Spécifie l'étendue d'entrée de la saisie de texte, indiquant le type d'informations autorisé. Cette étendue fournit une indication sur le texte que le jeu peut souhaiter. Le jeu devra quand même valider le texte qu'il récupère du clavier.

*maxTextLength*   \_In\_<br />Type : uint32\_t

Nombre maximal de caractères que l'utilisateur peut entrer dans l'interface utilisateur de saisie de texte. Sur console, le nombre maximal de caractères est de 1024. Sur PC, il n'y a aucune limite. Si la valeur 0 est passée, elle est traitée comme une longueur maximale de 1024 caractères. De plus, si *inputScope* a la valeur XGameUiTextEntryInputScope::Password, la longueur maximale est toujours de 1024 et la valeur *maxTextLength* est ignorée.

### Valeur de retour

Type : HRESULT

Code de réussite ou d'erreur HRESULT de l'appel asynchrone.

Pour obtenir le résultat, appelez [XGameUiShowTextEntryResultSize](/fr/reference/system/xgameui/functions/xgameuishowtextentryresultsize) et [XGameUiShowTextEntryResult](/fr/reference/system/xgameui/functions/xgameuishowtextentryresult) dans le rappel *AsyncBlock* ou une fois l'*AsyncBlock* terminé.

## Remarques

Sur les consoles, cette fonction fournit à la fois un champ de saisie de texte et un clavier virtuel à l'écran (OSK). Sous Windows, elle fournit une nouvelle fenêtre avec un champ de saisie de texte. Un clavier virtuel n'apparaît sous Windows que si l'utilisateur est configuré pour utiliser un clavier visuel (par exemple en mode tablette) plutôt qu'un clavier physique.

L'appel d'une interface utilisateur fait passer votre jeu en *mode contraint*. En mode contraint, votre titre reçoit moins de ressources système lorsqu'il se trouve en arrière-plan de l'interface utilisateur appelée. Pour en savoir plus sur le mode contraint et les autres modes de fonctionnement de votre titre, consultez [Cycle de vie des jeux XBOX (rubrique sous NDA)](/fr/build/console-features/console-workflows/xbox-game-life-cycle).

## Configuration requise

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

**Bibliothèque :** xgameruntime.lib

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

## Voir aussi

[XGameUI](/fr/reference/system/xgameui/xgameui_members)<br />[Prise en charge du clavier virtuel](/fr/build/core-features/common/input/overviews/virtualkeyboardsupport) [XGameUIShowTextEntryResult](/fr/reference/system/xgameui/functions/xgameuishowtextentryresult)<br />[XGameUIShowTextEntryResultSize](/fr/reference/system/xgameui/functions/xgameuishowtextentryresultsize)<br />[Cycle de vie des jeux XBOX (rubrique sous NDA)](/fr/build/console-features/console-workflows/xbox-game-life-cycle)


## Related topics

- [XGameUiShowTextEntryAsync](/reference/system/xgameui/functions/xgameuishowtextentryasync.md)
- [XGameUiShowTextEntryResult](/reference/system/xgameui/functions/xgameuishowtextentryresult.md)
- [XGameUiShowTextEntryResultSize](/reference/system/xgameui/functions/xgameuishowtextentryresultsize.md)
- [XGameUiShowTextEntryUiCallback](/reference/system/xgameui/functions/xgameuishowtextentryuicallback.md)