通过

XGameUiTextEntryGetState

  • 项目

获取打开的虚拟键盘的当前状态。

语法

HRESULT XGameUiTextEntryGetState(  
         XGameUiTextEntryHandle handle,
         XGameUiTextEntryChangeTypeFlags* changeType,
         uint32_t* cursorIndex,
         uint32_t* imeClauseStartIndex,
         uint32_t* imeClauseEndIndex,
         uint32_t bufferSize,
         char* buffer
)

参数

handle _In_
类型：XGameUiTextEntryHandle

打开的虚拟键盘的句柄。

changeType _Out_
类型： XGameUiTextEntryChangeTypeFlags*

描述自游戏上次调用 XGameUiTextEntryGetState以来文本是否已更改或虚拟键盘已关闭。 如果更改类型指示虚拟键盘已关闭，则在处理完文本更改后，游戏必须调用 XGameUiTextEntryClose。

cursorIndex _Out_opt_
类型：uint32_t*

光标相对于起始字符的字节索引。

imeClauseStartIndex _Out_opt_
类型：uint32_t*

可能被输入法候选项替换的输入法子句的起始字节索引。 这将位于游标索引之前。 如果输入法未在使用中，则此值将为零。

imeClauseEndIndex _Out_opt_
类型：uint32_t*

可能被输入法候选项替换的输入法子句的结束字节索引。 这将位于光标索引之后。 如果输入法未在使用中，则此值将为零。

bufferSize _In_
类型：uint32_t

将从虚拟键盘获取文本的游戏提供的缓冲区的大小（以字节为单位）。

buffer _Out_
类型：char*

以 null 结尾的字符串形式输入到虚拟键盘中的完整文本。 换行符将表示为“\n”。

返回值

类型：HRESULT

HRESULT 成功或错误代码。 有关错误代码的列表，请参阅错误代码。

返回代码 说明
S_OK 操作成功。
E_GAMEUI_TEXTENTRY_NOT_SHOWN XGameUiTextEntryHandle 无效，可能是因为需要调用 XGameUiTextEntryOpen。

备注

每个帧至少需要调用一次此函数，才能获取最新的虚拟键盘更改。 如果键盘稍后关闭，则该函数将成功返回；但是，更改类型将包括 KeyboardDismissed。

要求

头文件： XGameUI.h

库：xgameruntime.lib

支持平台：Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XGameUI
XGameUiTextEntryOpenXGameUiTextEntryClose