XGameUiTextEntryGetState
Obtient l’état actuel du clavier virtuel ouvert.Syntaxe
Paramètres
handle _In_Type : XGameUiTextEntryHandle Handle du clavier virtuel ouvert. changeType _Out_
Type : 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 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.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 SeriesVoir aussi
XGameUIXGameUiTextEntryOpen XGameUiTextEntryClose