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

## 結構

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

## 列舉

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

## 錯誤碼

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

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

## 概念文件

* [非同步程式設計的設計目標與改進](https://docs.xbox.com/zh-TW/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://docs.xbox.com/zh-TW/build/gdk-and-engines/unity/unity-api-wrappers.md)

## 另請參閱

[系統 API 參考](https://docs.xbox.com/zh-TW/reference/system/gc-reference-system-toc.md)


## Related topics

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