> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XGameUI（API 内容）

> XGameUI

# XGameUI

XboxGameUI API 允许游戏在 XBOX One 主机上调出预定义的用户界面显示。这些预定义 UI 包括用户选择器、个人资料卡、游戏邀请等多种界面。

## 函数

| 函数 | 说明 |
| - | - |
| [XGameUiSetNotificationPositionHint](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisetnotificationpositionhint.md) | 设置当前游戏上显示的 Toast 通知的首选位置。 |
| [XGameUiShowAchievementsAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowachievementsasync.md) | 显示 UI，向请求玩家展示指定游戏的成就。 |
| [XGameUiShowAchievementsResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowachievementsresult.md) | 获取对 [XGameUiShowAchievementsAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowachievementsasync.md) 调用的结果。 |
| [XGameUiShowErrorDialogAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowerrordialogasync.md) | 显示错误对话框的 UI，其中包含针对指定错误代码的服务定义错误字符串。 |
| [XGameUiShowErrorDialogResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowerrordialogresult.md) | 获取对 [XGameUiShowErrorDialogAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowerrordialogasync.md) 调用的结果。 |
| [XGameUiShowMessageDialogAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowmessagedialogasync.md) | 显示可自定义消息对话框的 UI。 |
| [XGameUiShowMessageDialogResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowmessagedialogresult.md) | 获取对 [XGameUiShowMessageDialogAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowmessagedialogasync.md) 调用的结果。 |
| [XGameUiShowMultiplayerActivityGameInviteAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteasync.md) | 待定 |
| [XGameUiShowMultiplayerActivityGameInviteResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteresult.md) | 待定 |
| [XGameUiShowPlayerPickerAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerpickerasync.md) | 显示一个选择器 UI，允许游戏玩家从显示的人员列表中选择玩家。 |
| [XGameUiShowPlayerPickerResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerpickerresult.md) | 获取 [XGameUiShowPlayerPickerAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerpickerasync.md) 调用的结果。 |
| [XGameUiShowPlayerPickerResultCount](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerpickerresultcount.md) | 获取 [XGameUiShowPlayerPickerAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerpickerasync.md) 调用的结果计数。 |
| [XGameUiShowPlayerProfileCardAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync.md) | 显示指定玩家的个人资料卡 UI。 |
| [XGameUiShowPlayerProfileCardResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerprofilecardresult.md) | 获取对 [XGameUiShowPlayerProfileCardAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync.md) 调用的结果。 |
| [XGameUiShowSendGameInviteAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowsendgameinviteasync.md) | 显示一个从所选玩家的好友列表和推荐好友列表中填充的选择器 UI。 |
| [XGameUiShowSendGameInviteResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowsendgameinviteresult.md) | 获取对 [XGameUIShowSendGameInviteAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowsendgameinviteasync.md) 调用的结果。 |
| [XGameUiShowStateShareAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowstateshareasync.md) | 显示用于与其他玩家共享状态的 UI |
| [XGameUiShowStateShareResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowstateshareresult.md) | 获取对 [XGameUIShowStateShareAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowstateshareasync.md) 调用的结果 |
| [XGameUiShowTextEntryAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowtextentryasync.md) | 显示一个文本输入 UI，供用户输入信息。 |
| [XGameUiShowTextEntryResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowtextentryresult.md) | 获取 [XGameUiShowTextEntryAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowtextentryasync.md) 调用的结果。 |
| [XGameUiShowTextEntryResultSize](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowtextentryresultsize.md) | 获取 [XGameUiShowTextEntryAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowtextentryasync.md) 调用返回缓冲区的大小。 |
| [XGameUiShowWebAuthenticationAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowwebauthenticationasync.md) | 显示一个 Web UI，允许用户委托访问外部网站和服务，而无需直接向正在运行的游戏提供其凭据。 |
| [XGameUiShowWebAuthenticationResult](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowwebauthenticationresult.md) | 获取 [XGameUiShowWebAuthenticationAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowwebauthenticationasync.md) 调用的结果。 |
| [XGameUiShowWebAuthenticationResultSize](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowwebauthenticationresultsize.md) | 获取包含身份验证请求结果所需的缓冲区大小。 |
| [XGameUiShowWebAuthenticationWithOptionsAsync](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowwebauthenticationwithoptionsasync.md) | 显示一个 Web UI（可选择全屏显示），允许用户委托访问外部网站和服务，而无需直接向正在运行的游戏提供其凭据。 |
| [XGameUiTextEntryClose](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuitextentryclose.md) | 关闭虚拟键盘并释放相应的资源。 |
| [XGameUiTextEntryGetExtents](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuitextentrygetextents.md) | 获取虚拟键盘的屏幕范围。 |
| [XGameUiTextEntryGetState](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuitextentrygetstate.md) | 获取已打开虚拟键盘的当前状态。 |
| [XGameUiTextEntryOpen](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuitextentryopen.md) | 打开一个虚拟键盘，由游戏负责渲染文本。 |
| [XGameUiTextEntryUpdatePositionHint](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuitextentryupdatepositionhint.md) | 更新虚拟键盘的首选定位。 |
| [XGameUiTextEntryUpdateVisibility](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuitextentryupdatevisibility.md) | 更新是显示完整虚拟键盘，还是仅显示候选列表。 |
| [XGameUISetUICallbacks](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisetuicallbacks.md) | 设置开发者定义的 UI 回调。 |
| [XGameUISetMessageDialogUIResponse](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisetmessagedialoguiresponse.md) | 设置由 XGameUiShowMessageDialogResult 返回的结果 XGameUiMessageDialogButton 值。 |
| [XGameUISetPlayerPickerUIResponse](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisetplayerpickeruiresponse.md) | 设置由 XGameUiShowPlayerPickerResultCount 和 XGameUiShowPlayerPickerResult 返回的结果。 |
| [XGameUISetTextEntryUIResponse](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisettextentryuiresponse.md) | 设置由 XGameUiShowTextEntryAsync 返回的结果文本长度和文本。 |
| [XGameUISetPlayerProfileCardUIResponse](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisetplayerprofilecarduiresponse.md) | 完成对 XGameUiShowPlayerProfileCardAsync 的调用。 |
| [XGameUISetSendGameInviteUIResponse](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisetsendgameinviteuiresponse.md) | 完成对 XGameUiShowSendGameInviteAsync 的调用。 |
| [XGameUISetAchievementsUIResponse](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisetachievementsuiresponse.md) | 完成对 XGameUiShowAchievementsAsync 的调用。 |
| [XGameUISetMultiplayerActivityGameInviteUIResponse](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuisetmultiplayeractivitygameinviteuiresponse.md) | 完成对 XGameUiShowMultiplayerActivityGameInviteAsync 的调用。 |
| [XGameUISetErrorDialogUIResponse](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuiseterrordialoguiresponse.md) | 完成对 XGameUiShowErrorDialogAsync 的调用。 |
| [XGameUIShowPlayerProfileCardUICallback](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerprofilecarduicallback.md) | XGameUiShowPlayerProfileCardAsync 回调的签名。 |
| [XGameUIShowPlayerPickerUICallback](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowplayerpickeruicallback.md) | XGameUiShowPlayerPickerAsync 回调的签名。 |
| [XGameUIShowSendGameInviteUICallback](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowsendgameinviteuicallback.md) | XGameUiShowSendGameInviteAsync 回调的签名。 |
| [XGameUIShowAchievementsUICallback](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowachievementsuicallback.md) | XGameUiShowAchievementsAsync 回调的签名。 |
| [XGameUIShowMultiplayerActivityGameInviteUICallback](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteuicallback.md) | XGameUiShowMultiplayerActivityGameInviteAsync 回调的签名。 |
| [XGameUIShowMessageDialogUICallback](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowmessagedialoguicallback.md) | XGameUiShowMessageDialogAsync 回调的签名。 |
| [XGameUIShowErrorDialogUICallback](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowerrordialoguicallback.md) | XGameUiShowErrorDialogAsync 回调的签名。 |
| [XGameUIShowTextEntryUICallback](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuishowtextentryuicallback.md) | XGameUiShowTextEntryAsync 回调的签名。 |

## 结构

| 结构 | 说明 |
| - | - |
| [XGameUiWebAuthenticationResultData](https://docs.xbox.com/zh-CN/reference/system/xgameui/structs/xgameuiwebauthenticationresultdata.md) | 包含 Web 身份验证请求的响应。 |
| [XGameUiTextEntryExtents](https://docs.xbox.com/zh-CN/reference/system/xgameui/structs/xgameuitextentryextents.md) | 描述虚拟键盘的相对定位。 |
| [XGameUiTextEntryOptions](https://docs.xbox.com/zh-CN/reference/system/xgameui/structs/xgameuitextentryoptions.md) | XGameUiTextEntryOpen 所使用的虚拟键盘的初始选项集。 |
| [XGameUICallbackHandle](https://docs.xbox.com/zh-CN/reference/system/xgameui/structs/xgameuicallbackhandle.md) | 与 XGameUi 回调调用关联的句柄。用于调用 Set\*Response API。 |
| [XGameUIPlayerPickerInfo](https://docs.xbox.com/zh-CN/reference/system/xgameui/structs/xgameuiplayerpickerinfo.md) | 用于封装开发者自定义玩家选择器 UI 所需用户信息的结构。 |
| [XGameUIUICallbacks](https://docs.xbox.com/zh-CN/reference/system/xgameui/structs/xgameuiuicallbacks.md) | 包含指向开发者定义的 UI 回调的指针的结构。 |

## 枚举

| 枚举 | 说明 |
| - | - |
| [XGameUiMessageDialogButton](https://docs.xbox.com/zh-CN/reference/system/xgameui/enums/xgameuimessagedialogbutton.md) | 枚举可自定义消息对话框中的按钮。 |
| [XGameUiNotificationPositionHint](https://docs.xbox.com/zh-CN/reference/system/xgameui/enums/xgameuinotificationpositionhint.md) | 描述当前游戏上显示的 Toast 通知的首选位置。 |
| [XGameUiTextEntryChangeTypeFlags](https://docs.xbox.com/zh-CN/reference/system/xgameui/enums/xgameuitextentrychangetypeflags.md) | 指示自上次调用 XGameUiTextEntryGetState 以来发生变化的标志。 |
| [XGameUiTextEntryInputScope](https://docs.xbox.com/zh-CN/reference/system/xgameui/enums/xgameuitextentryinputscope.md) | 枚举文本输入中期望的信息类型。 |
| [XGameUiTextEntryPositionHint](https://docs.xbox.com/zh-CN/reference/system/xgameui/enums/xgameuitextentrypositionhint.md) | 关于虚拟键盘最佳位置的提示。 |
| [XGameUiTextEntryVisibilityFlags](https://docs.xbox.com/zh-CN/reference/system/xgameui/enums/xgameuitextentryvisibilityflags.md) | 指示虚拟键盘可见性状态的标志。 |
| [XGameUiWebAuthenticationOptions](https://docs.xbox.com/zh-CN/reference/system/xgameui/enums/xgameuiwebauthenticationoptions.md) | 枚举呈现 Web 身份验证流程的选项。 |

## 错误代码

XGameUI API 可能返回以下错误代码。有关完整列表，请参阅[错误代码](https://docs.xbox.com/zh-CN/reference/errorcodes.md)。

| 代码 | 值 | 说明 |
| - | - | - |
| E\_GAMEUI\_TEXTENTRY\_NOT\_SHOWN | — | XGameUiTextEntryHandle 无效，很可能是因为需要先调用 [XGameUiTextEntryOpen](https://docs.xbox.com/zh-CN/reference/system/xgameui/functions/xgameuitextentryopen.md)。 |

## 概念文档

* [异步编程的设计目标与改进](https://docs.xbox.com/zh-CN/build/core-features/common/async/async-whitepaper.md)
* [时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)
* [什么是 Microsoft Game Development Kit？](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/intro/introduction)
* [在 Unity 项目中使用适用于 GDK API 的 C# 包装器](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/pc-dev/tutorials/get-started-with-unity-pc/features/gdk-unity-api-wrappers)

## 请参阅

[系统 API 参考](https://docs.xbox.com/zh-CN/reference/system/gc-reference-system-toc.md)


## Related topics

- [XGame（API 内容）](https://docs.xbox.com/zh-CN/reference/system/xgame/xgame_members.md)
- [XGameSave（API 内容）](https://docs.xbox.com/zh-CN/reference/system/xgamesave/xgamesave_members.md)
- [XGameStreaming（API 内容）](https://docs.xbox.com/zh-CN/reference/system/xgamestreaming/xgamestreaming_members.md)
- [XGameEvent（API 内容）](https://docs.xbox.com/zh-CN/reference/system/xgameevent/xgameevent_members.md)
- [XGameActivation（API 内容）](https://docs.xbox.com/zh-CN/reference/system/xgameactivation/xgameactivation_members.md)