Skip to main content

XGameUiTextEntryGetState

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

语法

参数

handle   _In_
类型:XGameUiTextEntryHandle
已打开的虚拟键盘的句柄。 changeType   _Out_
类型:XGameUiTextEntryChangeTypeFlags*
描述自游戏上次调用 XGameUiTextEntryGetState 以来文本是否发生变化或虚拟键盘是否已被关闭。如果 change type 表示虚拟键盘已被关闭,则在处理完文本变化后,游戏必须调用 XGameUiTextEntryClose cursorIndex   _Out_opt_
类型:uint32_t*
光标相对于起始字符的字节索引。 imeClauseStartIndex   _Out_opt_
类型:uint32_t*
可能被 IME 候选项替换的 IME 子句的起始字节索引。此索引将位于光标索引之前。如果未使用 IME,则该值为零。 imeClauseEndIndex   _Out_opt_
类型:uint32_t*
可能被 IME 候选项替换的 IME 子句的结束字节索引。此索引将位于光标索引之后。如果未使用 IME,则该值为零。 bufferSize   _In_
类型:uint32_t
游戏提供的用于接收虚拟键盘文本的缓冲区大小(以字节为单位)。 buffer   _Out_
类型:char*
以以 null 结尾的字符串形式输入到虚拟键盘的完整文本。换行符将表示为 ‘\n’。

返回值

类型:HRESULT HRESULT 成功或错误代码。有关错误代码列表,请参阅错误代码

备注

每帧至少需要调用此函数一次,以获取最新的虚拟键盘更改。如果键盘随后被关闭,此函数将成功返回;然而,change type 将包含 KeyboardDismissed。

要求

标头: XGameUI.h 库: xgameruntime.lib 支持的平台: Windows、XBOX One 系列主机和 XBOX Series 主机

请参阅

XGameUI
XGameUiTextEntryOpen XGameUiTextEntryClose
最后修改于 2026年8月24日