XGameUiShowTextEntryAsync
Affiche une interface utilisateur de saisie de texte permettant à un utilisateur d’entrer des informations.Syntaxe
Paramètres
async _In_Type : XAsyncBlock* Pointeur vers le XAsyncBlock qui est passé à XAsyncRun. titleText _In_opt_z_
Type : char* Le texte du titre de l’interface utilisateur de saisie de texte. descriptionText _In_opt_z_
Type : char* Le texte de description de l’interface utilisateur de saisie de texte. defaultText _In_opt_z_
Type : char* Texte par défaut qui est initialement inscrit dans l’interface utilisateur de saisie de texte. inputScope _In_
Type : XGameUiTextEntryInputScope Spécifie l’étendue d’entrée de la saisie de texte, qui indique le type d’informations autorisé. Cette étendue donne une indication du texte que le jeu peut souhaiter obtenir. Le jeu devra quand même valider le texte qu’il reçoit du clavier. maxTextLength _In_
Type : uint32_t Le 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 sera traitée comme une longueur maximale de 1024 caractères. De plus, si inputScope est XGameUiTextEntryInputScope::Password, la longueur maximale sera toujours de 1024 et la valeur maxTextLength sera 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 et XGameUiShowTextEntryResult dans le rappel de l’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). Sur Windows, elle fournit une nouvelle fenêtre avec un champ de saisie de texte. Un clavier virtuel n’apparaîtra sur Windows que si l’utilisateur est configuré pour utiliser un clavier à l’écran (par exemple en mode tablette) plutôt qu’un clavier physique. L’appel d’une interface utilisateur fera passer votre jeu en mode limité. En mode limité, votre titre recevra moins de ressources système pendant qu’il se trouve en arrière-plan de l’interface utilisateur appelée. Pour en savoir plus sur le mode limité et les autres modes de fonctionnement de votre titre, consultez Cycle de vie des jeux XBOX (rubrique sous NDA).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 SeriesVoir aussi
XGameUIPrise en charge du clavier virtuel XGameUIShowTextEntryResult
XGameUIShowTextEntryResultSize
Cycle de vie des jeux XBOX (rubrique sous NDA)