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

# XGameUI

> XGameUI

# XGameUI

XboxGameUI API 可讓遊戲在 XBOX One 主機上叫出預先定義的使用者介面顯示畫面。這些預先定義的 UI 包括使用者選擇器、設定檔卡片和遊戲邀請等介面。

## 函式

| 函式 | 描述 |
| - | - |
| [XGameUiSetNotificationPositionHint](/zh-TW/reference/system/xgameui/functions/xgameuisetnotificationpositionhint) | 設定在目前遊戲上顯示快顯通知的慣用位置。 |
| [XGameUiShowAchievementsAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowachievementsasync) | 顯示 UI，呈現提出要求之玩家在指定遊戲中的成就。 |
| [XGameUiShowAchievementsResult](/zh-TW/reference/system/xgameui/functions/xgameuishowachievementsresult) | 取得呼叫 [XGameUiShowAchievementsAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowachievementsasync) 的結果。 |
| [XGameUiShowErrorDialogAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowerrordialogasync) | 顯示錯誤對話方塊 UI，其中包含指定錯誤碼的服務定義錯誤字串。 |
| [XGameUiShowErrorDialogResult](/zh-TW/reference/system/xgameui/functions/xgameuishowerrordialogresult) | 取得呼叫 [XGameUiShowErrorDialogAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowerrordialogasync) 的結果。 |
| [XGameUiShowMessageDialogAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowmessagedialogasync) | 顯示可自訂的訊息對話方塊 UI。 |
| [XGameUiShowMessageDialogResult](/zh-TW/reference/system/xgameui/functions/xgameuishowmessagedialogresult) | 取得呼叫 [XGameUiShowMessageDialogAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowmessagedialogasync) 的結果。 |
| [XGameUiShowMultiplayerActivityGameInviteAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteasync) | 待定 |
| [XGameUiShowMultiplayerActivityGameInviteResult](/zh-TW/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteresult) | 待定 |
| [XGameUiShowPlayerPickerAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerpickerasync) | 顯示選擇器 UI，讓正在玩遊戲的人從呈現的人員清單中選取玩家。 |
| [XGameUiShowPlayerPickerResult](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerpickerresult) | 從 [XGameUiShowPlayerPickerAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerpickerasync) 呼叫取得結果。 |
| [XGameUiShowPlayerPickerResultCount](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerpickerresultcount) | 從 [XGameUiShowPlayerPickerAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerpickerasync) 呼叫取得結果數目。 |
| [XGameUiShowPlayerProfileCardAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync) | 顯示指定玩家之設定檔卡片的 UI。 |
| [XGameUiShowPlayerProfileCardResult](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerprofilecardresult) | 取得呼叫 [XGameUiShowPlayerProfileCardAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync) 的結果。 |
| [XGameUiShowSendGameInviteAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowsendgameinviteasync) | 顯示選擇器 UI，內容取自所選玩家的好友清單和建議好友清單。 |
| [XGameUiShowSendGameInviteResult](/zh-TW/reference/system/xgameui/functions/xgameuishowsendgameinviteresult) | 取得呼叫 [XGameUIShowSendGameInviteAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowsendgameinviteasync) 的結果。 |
| [XGameUiShowStateShareAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowstateshareasync) | 顯示與其他玩家分享狀態的 UI |
| [XGameUiShowStateShareResult](/zh-TW/reference/system/xgameui/functions/xgameuishowstateshareresult) | 取得呼叫 [XGameUIShowStateShareAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowstateshareasync) 的結果 |
| [XGameUiShowTextEntryAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowtextentryasync) | 顯示文字輸入 UI，供使用者輸入資訊。 |
| [XGameUiShowTextEntryResult](/zh-TW/reference/system/xgameui/functions/xgameuishowtextentryresult) | 從 [XGameUiShowTextEntryAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowtextentryasync) 呼叫取得結果。 |
| [XGameUiShowTextEntryResultSize](/zh-TW/reference/system/xgameui/functions/xgameuishowtextentryresultsize) | 從 [XGameUiShowTextEntryAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowtextentryasync) 呼叫取得傳回緩衝區的大小。 |
| [XGameUiShowWebAuthenticationAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowwebauthenticationasync) | 顯示 Web UI，讓使用者無須直接將其認證提供給執行中的遊戲，即可委派對外部網站和服務的存取權。 |
| [XGameUiShowWebAuthenticationResult](/zh-TW/reference/system/xgameui/functions/xgameuishowwebauthenticationresult) | 從 [XGameUiShowWebAuthenticationAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowwebauthenticationasync) 呼叫取得結果。 |
| [XGameUiShowWebAuthenticationResultSize](/zh-TW/reference/system/xgameui/functions/xgameuishowwebauthenticationresultsize) | 擷取容納驗證要求結果所需的緩衝區大小。 |
| [XGameUiShowWebAuthenticationWithOptionsAsync](/zh-TW/reference/system/xgameui/functions/xgameuishowwebauthenticationwithoptionsasync) | 顯示 Web UI (可選擇以全螢幕顯示)，讓使用者無須直接將其認證提供給執行中的遊戲，即可委派對外部網站和服務的存取權。 |
| [XGameUiTextEntryClose](/zh-TW/reference/system/xgameui/functions/xgameuitextentryclose) | 關閉虛擬鍵盤並釋放對應的資源。 |
| [XGameUiTextEntryGetExtents](/zh-TW/reference/system/xgameui/functions/xgameuitextentrygetextents) | 取得虛擬鍵盤的螢幕範圍。 |
| [XGameUiTextEntryGetState](/zh-TW/reference/system/xgameui/functions/xgameuitextentrygetstate) | 取得已開啟虛擬鍵盤的目前狀態。 |
| [XGameUiTextEntryOpen](/zh-TW/reference/system/xgameui/functions/xgameuitextentryopen) | 開啟由遊戲負責轉譯文字的虛擬鍵盤。 |
| [XGameUiTextEntryUpdatePositionHint](/zh-TW/reference/system/xgameui/functions/xgameuitextentryupdatepositionhint) | 更新虛擬鍵盤的慣用位置。 |
| [XGameUiTextEntryUpdateVisibility](/zh-TW/reference/system/xgameui/functions/xgameuitextentryupdatevisibility) | 更新要顯示完整虛擬鍵盤還是僅顯示候選清單。 |
| [XGameUISetUICallbacks](/zh-TW/reference/system/xgameui/functions/xgameuisetuicallbacks) | 設定開發人員定義的 UI 回呼。 |
| [XGameUISetMessageDialogUIResponse](/zh-TW/reference/system/xgameui/functions/xgameuisetmessagedialoguiresponse) | 設定要由 XGameUiShowMessageDialogResult 傳回的結果 XGameUiMessageDialogButton 值。 |
| [XGameUISetPlayerPickerUIResponse](/zh-TW/reference/system/xgameui/functions/xgameuisetplayerpickeruiresponse) | 設定要由 XGameUiShowPlayerPickerResultCount 和 XGameUiShowPlayerPickerResult 傳回的結果。 |
| [XGameUISetTextEntryUIResponse](/zh-TW/reference/system/xgameui/functions/xgameuisettextentryuiresponse) | 設定要由 XGameUiShowTextEntryAsync 傳回的結果文字長度和文字。 |
| [XGameUISetPlayerProfileCardUIResponse](/zh-TW/reference/system/xgameui/functions/xgameuisetplayerprofilecarduiresponse) | 完成對 XGameUiShowPlayerProfileCardAsync 的呼叫。 |
| [XGameUISetSendGameInviteUIResponse](/zh-TW/reference/system/xgameui/functions/xgameuisetsendgameinviteuiresponse) | 完成對 XGameUiShowSendGameInviteAsync 的呼叫。 |
| [XGameUISetAchievementsUIResponse](/zh-TW/reference/system/xgameui/functions/xgameuisetachievementsuiresponse) | 完成對 XGameUiShowAchievementsAsync 的呼叫。 |
| [XGameUISetMultiplayerActivityGameInviteUIResponse](/zh-TW/reference/system/xgameui/functions/xgameuisetmultiplayeractivitygameinviteuiresponse) | 完成對 XGameUiShowMultiplayerActivityGameInviteAsync 的呼叫。 |
| [XGameUISetErrorDialogUIResponse](/zh-TW/reference/system/xgameui/functions/xgameuiseterrordialoguiresponse) | 完成對 XGameUiShowErrorDialogAsync 的呼叫。 |
| [XGameUIShowPlayerProfileCardUICallback](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerprofilecarduicallback) | XGameUiShowPlayerProfileCardAsync 回呼的簽章。 |
| [XGameUIShowPlayerPickerUICallback](/zh-TW/reference/system/xgameui/functions/xgameuishowplayerpickeruicallback) | XGameUiShowPlayerPickerAsync 回呼的簽章。 |
| [XGameUIShowSendGameInviteUICallback](/zh-TW/reference/system/xgameui/functions/xgameuishowsendgameinviteuicallback) | XGameUiShowSendGameInviteAsync 回呼的簽章。 |
| [XGameUIShowAchievementsUICallback](/zh-TW/reference/system/xgameui/functions/xgameuishowachievementsuicallback) | XGameUiShowAchievementsAsync 回呼的簽章。 |
| [XGameUIShowMultiplayerActivityGameInviteUICallback](/zh-TW/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteuicallback) | XGameUiShowMultiplayerActivityGameInviteAsync 回呼的簽章。 |
| [XGameUIShowMessageDialogUICallback](/zh-TW/reference/system/xgameui/functions/xgameuishowmessagedialoguicallback) | XGameUiShowMessageDialogAsync 回呼的簽章。 |
| [XGameUIShowErrorDialogUICallback](/zh-TW/reference/system/xgameui/functions/xgameuishowerrordialoguicallback) | XGameUiShowErrorDialogAsync 回呼的簽章。 |
| [XGameUIShowTextEntryUICallback](/zh-TW/reference/system/xgameui/functions/xgameuishowtextentryuicallback) | XGameUiShowTextEntryAsync 回呼的簽章。 |

## 結構

| 結構 | 描述 |
| - | - |
| [XGameUiWebAuthenticationResultData](/zh-TW/reference/system/xgameui/structs/xgameuiwebauthenticationresultdata) | 包含 Web 驗證要求的回應。 |
| [XGameUiTextEntryExtents](/zh-TW/reference/system/xgameui/structs/xgameuitextentryextents) | 描述虛擬鍵盤的相對位置。 |
| [XGameUiTextEntryOptions](/zh-TW/reference/system/xgameui/structs/xgameuitextentryoptions) | XGameUiTextEntryOpen 所使用之虛擬鍵盤的初始選項集。 |
| [XGameUICallbackHandle](/zh-TW/reference/system/xgameui/structs/xgameuicallbackhandle) | 與 XGameUi 回呼叫用相關聯的控制代碼。用於呼叫 Set\*Response API。 |
| [XGameUIPlayerPickerInfo](/zh-TW/reference/system/xgameui/structs/xgameuiplayerpickerinfo) | 封裝使用者資訊的結構，供開發人員的自訂玩家選擇器 UI 使用。 |
| [XGameUIUICallbacks](/zh-TW/reference/system/xgameui/structs/xgameuiuicallbacks) | 包含開發人員定義之 UI 回呼指標的結構。 |

## 列舉

| 列舉 | 描述 |
| - | - |
| [XGameUiMessageDialogButton](/zh-TW/reference/system/xgameui/enums/xgameuimessagedialogbutton) | 列舉可自訂訊息對話方塊中的按鈕。 |
| [XGameUiNotificationPositionHint](/zh-TW/reference/system/xgameui/enums/xgameuinotificationpositionhint) | 描述在目前遊戲上顯示快顯通知的慣用位置。 |
| [XGameUiTextEntryChangeTypeFlags](/zh-TW/reference/system/xgameui/enums/xgameuitextentrychangetypeflags) | 指出自上次呼叫 XGameUiTextEntryGetState 以來有哪些變更的旗標。 |
| [XGameUiTextEntryInputScope](/zh-TW/reference/system/xgameui/enums/xgameuitextentryinputscope) | 列舉文字輸入中預期的資訊類型。 |
| [XGameUiTextEntryPositionHint](/zh-TW/reference/system/xgameui/enums/xgameuitextentrypositionhint) | 虛擬鍵盤最佳放置位置的提示。 |
| [XGameUiTextEntryVisibilityFlags](/zh-TW/reference/system/xgameui/enums/xgameuitextentryvisibilityflags) | 指出虛擬鍵盤可見度狀態的旗標。 |
| [XGameUiWebAuthenticationOptions](/zh-TW/reference/system/xgameui/enums/xgameuiwebauthenticationoptions) | 列舉呈現 Web 驗證流程的選項。 |

## 錯誤碼

XGameUI API 可能會傳回下列錯誤碼。如需完整清單，請參閱[錯誤碼](/zh-TW/reference/errorcodes)。

| 代碼 | 值 | 描述 |
| - | - | - |
| E\_GAMEUI\_TEXTENTRY\_NOT\_SHOWN | — | XGameUiTextEntryHandle 無效，可能是因為您需要先呼叫 [XGameUiTextEntryOpen](/zh-TW/reference/system/xgameui/functions/xgameuitextentryopen)。 |

## 概念文件

* [非同步程式設計的設計目標與改進](/zh-TW/build/core-features/common/async/async-whitepaper)
* [時間敏感執行緒](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# 包裝函式](/zh-TW/build/gdk-and-engines/unity/unity-api-wrappers)

## 另請參閱

[系統 API 參考](/zh-TW/reference/system/gc-reference-system-toc)


## Related topics

- [XGameUI](/reference/system/xgameui/xgameui_members.md)
- [XGameUiShowSendGameInviteAsync](/reference/system/xgameui/functions/xgameuishowsendgameinviteasync.md)
- [XGameUiShowSendGameInviteResult](/reference/system/xgameui/functions/xgameuishowsendgameinviteresult.md)
