通过

XGameUiShowTextEntryAsync

  • 项目

显示供用户输入信息的文本输入 UI。

语法

HRESULT XGameUiShowTextEntryAsync(  
         XAsyncBlock* async,  
         const char* titleText,  
         const char* descriptionText,  
         const char* defaultText,  
         XGameUiTextEntryInputScope inputScope,  
         uint32_t maxTextLength  
)

参数

async _In_
类型：XAsyncBlock*

指向传递到 XAsyncRun 的 XAsyncBlock 的指针。

titleText _In_opt_z_
类型：char*

文本输入 UI 的文本标题。

descriptionText _In_opt_z_
类型：char*

文本输入 UI 的文本描述。

defaultText _In_opt_z_
类型：char*

在文本输入 UI 中最初填充的默认文本。

inputScope _In_
类型：XGameUiTextEntryInputScope

指定文本条目的输入范围，指示允许的信息的类型。 此范围提供了关于游戏可能需要的文本的提示。 游戏仍将需要验证从键盘返回的文本。

maxTextLength _In_
类型：uint32_t

用户可以在文本输入 UI 中输入的最大字符数。 在主机上，最大字符数为 1024。 在电脑上，没有限制。 如果传入值 0，则会将其视为最大字符长度 1024。 此外，如果 inputScope为 XGameUiTextEntryInputScope::Password，则最大长度将始终为 1024，并将忽略 maxTextLength值。

返回值

类型：HRESULT

异步调用的 HRESULT 成功或错误代码。

要获取结果，请在 AsyncBlock 回调中或 AsyncBlock 完成后调用 XGameUiShowTextEntryResultSize 和 XGameUiShowTextEntryResult。

备注

在主机上，将提供文本输入字段和屏幕虚拟键盘 (OSK)。 在 Windows 上，将提供带有文本输入字段的新窗口。 仅当用户配置为使用屏幕键盘（例如处于平板电脑模式）而不是使用物理键盘时，虚拟键盘才会出现在 Windows 上。

调用 UI 将导致游戏进入约束模式。 在约束模式下，您的游戏将在处于已调用的 UI 的后台中时接收较少的系统资源。 要详细了解游戏的约束模式和其他操作模式，请参阅 Xbox 游戏生命周期（NDA 主题）。

要求

头文件： XGameUI.h

库：xgameruntime.lib

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

另请参阅

XGameUI
虚拟键盘支持XGameUIShowTextEntryResult
XGameUIShowTextEntryResultSize
Xbox 游戏生命周期（NDA 主题）