> ## 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](/reference/system/xgameui/functions/xgameuisetnotificationpositionhint)                                 | 現在のタイトルでトースト通知を表示する推奨位置を設定します。                                                                                            |
| [XGameUiShowAchievementsAsync](/reference/system/xgameui/functions/xgameuishowachievementsasync)                                             | 指定されたタイトルの、要求元プレイヤーの実績を表示する UI を表示します。                                                                                    |
| [XGameUiShowAchievementsResult](/reference/system/xgameui/functions/xgameuishowachievementsresult)                                           | [XGameUiShowAchievementsAsync](/reference/system/xgameui/functions/xgameuishowachievementsasync) 呼び出しの結果を取得します。           |
| [XGameUiShowErrorDialogAsync](/reference/system/xgameui/functions/xgameuishowerrordialogasync)                                               | 指定されたエラー コードに対して、サービスが定義したエラー文字列を含むエラー ダイアログの UI を表示します。                                                                  |
| [XGameUiShowErrorDialogResult](/reference/system/xgameui/functions/xgameuishowerrordialogresult)                                             | [XGameUiShowErrorDialogAsync](/reference/system/xgameui/functions/xgameuishowerrordialogasync) 呼び出しの結果を取得します。             |
| [XGameUiShowMessageDialogAsync](/reference/system/xgameui/functions/xgameuishowmessagedialogasync)                                           | カスタマイズ可能なメッセージ ダイアログの UI を表示します。                                                                                          |
| [XGameUiShowMessageDialogResult](/reference/system/xgameui/functions/xgameuishowmessagedialogresult)                                         | [XGameUiShowMessageDialogAsync](/reference/system/xgameui/functions/xgameuishowmessagedialogasync) 呼び出しの結果を取得します。         |
| [XGameUiShowMultiplayerActivityGameInviteAsync](/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteasync)           | TBD                                                                                                                       |
| [XGameUiShowMultiplayerActivityGameInviteResult](/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteresult)         | TBD                                                                                                                       |
| [XGameUiShowPlayerPickerAsync](/reference/system/xgameui/functions/xgameuishowplayerpickerasync)                                             | ゲームをプレイしている人が、提示された人物リストからプレイヤーを選択できるようにするピッカー UI を表示します。                                                                 |
| [XGameUiShowPlayerPickerResult](/reference/system/xgameui/functions/xgameuishowplayerpickerresult)                                           | [XGameUiShowPlayerPickerAsync](/reference/system/xgameui/functions/xgameuishowplayerpickerasync) 呼び出しの結果を取得します。           |
| [XGameUiShowPlayerPickerResultCount](/reference/system/xgameui/functions/xgameuishowplayerpickerresultcount)                                 | [XGameUiShowPlayerPickerAsync](/reference/system/xgameui/functions/xgameuishowplayerpickerasync) 呼び出しの結果の数を取得します。         |
| [XGameUiShowPlayerProfileCardAsync](/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync)                                   | 指定されたプレイヤーのプロフィール カードの UI を表示します。                                                                                         |
| [XGameUiShowPlayerProfileCardResult](/reference/system/xgameui/functions/xgameuishowplayerprofilecardresult)                                 | [XGameUiShowPlayerProfileCardAsync](/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync) 呼び出しの結果を取得します。 |
| [XGameUiShowSendGameInviteAsync](/reference/system/xgameui/functions/xgameuishowsendgameinviteasync)                                         | 選択したプレイヤーのフレンド リストと推奨フレンド リストから作成されたピッカー UI を表示します。                                                                       |
| [XGameUiShowSendGameInviteResult](/reference/system/xgameui/functions/xgameuishowsendgameinviteresult)                                       | [XGameUIShowSendGameInviteAsync](/reference/system/xgameui/functions/xgameuishowsendgameinviteasync) 呼び出しの結果を取得します。       |
| [XGameUiShowStateShareAsync](/reference/system/xgameui/functions/xgameuishowstateshareasync)                                                 | 他のプレイヤーと状態を共有するための UI を表示します                                                                                              |
| [XGameUiShowStateShareResult](/reference/system/xgameui/functions/xgameuishowstateshareresult)                                               | [XGameUIShowStateShareAsync](/reference/system/xgameui/functions/xgameuishowstateshareasync) 呼び出しの結果を取得します                |
| [XGameUiShowTextEntryAsync](/reference/system/xgameui/functions/xgameuishowtextentryasync)                                                   | ユーザーが情報を入力するためのテキスト エントリ UI を表示します。                                                                                       |
| [XGameUiShowTextEntryResult](/reference/system/xgameui/functions/xgameuishowtextentryresult)                                                 | [XGameUiShowTextEntryAsync](/reference/system/xgameui/functions/xgameuishowtextentryasync) 呼び出しの結果を取得します。                 |
| [XGameUiShowTextEntryResultSize](/reference/system/xgameui/functions/xgameuishowtextentryresultsize)                                         | [XGameUiShowTextEntryAsync](/reference/system/xgameui/functions/xgameuishowtextentryasync) 呼び出しからの戻りバッファーのサイズを取得します。      |
| [XGameUiShowWebAuthenticationAsync](/reference/system/xgameui/functions/xgameuishowwebauthenticationasync)                                   | 実行中のタイトルに資格情報を直接提供することなく、外部の Web サイトやサービスへのアクセスをユーザーが委任できる Web UI を表示します。                                                 |
| [XGameUiShowWebAuthenticationResult](/reference/system/xgameui/functions/xgameuishowwebauthenticationresult)                                 | [XGameUiShowWebAuthenticationAsync](/reference/system/xgameui/functions/xgameuishowwebauthenticationasync) 呼び出しの結果を取得します。 |
| [XGameUiShowWebAuthenticationResultSize](/reference/system/xgameui/functions/xgameuishowwebauthenticationresultsize)                         | 認証要求の結果を格納するために必要なバッファーのサイズを取得します。                                                                                        |
| [XGameUiShowWebAuthenticationWithOptionsAsync](/reference/system/xgameui/functions/xgameuishowwebauthenticationwithoptionsasync)             | 実行中のタイトルに資格情報を直接提供することなく、外部の Web サイトやサービスへのアクセスをユーザーが委任できる Web UI を、フル スクリーンで表示するオプション付きで表示します。                           |
| [XGameUiTextEntryClose](/reference/system/xgameui/functions/xgameuitextentryclose)                                                           | 仮想キーボードを閉じ、対応するリソースを解放します。                                                                                                |
| [XGameUiTextEntryGetExtents](/reference/system/xgameui/functions/xgameuitextentrygetextents)                                                 | 仮想キーボードの画面上の範囲を取得します。                                                                                                     |
| [XGameUiTextEntryGetState](/reference/system/xgameui/functions/xgameuitextentrygetstate)                                                     | 開いている仮想キーボードの現在の状態を取得します。                                                                                                 |
| [XGameUiTextEntryOpen](/reference/system/xgameui/functions/xgameuitextentryopen)                                                             | タイトルがテキストのレンダリングを担当する仮想キーボードを開きます。                                                                                        |
| [XGameUiTextEntryUpdatePositionHint](/reference/system/xgameui/functions/xgameuitextentryupdatepositionhint)                                 | 仮想キーボードの推奨配置を更新します。                                                                                                       |
| [XGameUiTextEntryUpdateVisibility](/reference/system/xgameui/functions/xgameuitextentryupdatevisibility)                                     | フルの仮想キーボードを表示するか、候補リストのみを表示するかを更新します。                                                                                     |
| [XGameUISetUICallbacks](/reference/system/xgameui/functions/xgameuisetuicallbacks)                                                           | 開発者が定義した UI コールバックを設定します。                                                                                                 |
| [XGameUISetMessageDialogUIResponse](/reference/system/xgameui/functions/xgameuisetmessagedialoguiresponse)                                   | XGameUiShowMessageDialogResult によって返される、結果となる XGameUiMessageDialogButton の値を設定します。                                        |
| [XGameUISetPlayerPickerUIResponse](/reference/system/xgameui/functions/xgameuisetplayerpickeruiresponse)                                     | XGameUiShowPlayerPickerResultCount と XGameUiShowPlayerPickerResult によって返される結果を設定します。                                      |
| [XGameUISetTextEntryUIResponse](/reference/system/xgameui/functions/xgameuisettextentryuiresponse)                                           | XGameUiShowTextEntryAsync によって返される結果テキストの長さとテキストを設定します。                                                                   |
| [XGameUISetPlayerProfileCardUIResponse](/reference/system/xgameui/functions/xgameuisetplayerprofilecarduiresponse)                           | XGameUiShowPlayerProfileCardAsync 呼び出しを完了します。                                                                             |
| [XGameUISetSendGameInviteUIResponse](/reference/system/xgameui/functions/xgameuisetsendgameinviteuiresponse)                                 | XGameUiShowSendGameInviteAsync 呼び出しを完了します。                                                                                |
| [XGameUISetAchievementsUIResponse](/reference/system/xgameui/functions/xgameuisetachievementsuiresponse)                                     | XGameUiShowAchievementsAsync 呼び出しを完了します。                                                                                  |
| [XGameUISetMultiplayerActivityGameInviteUIResponse](/reference/system/xgameui/functions/xgameuisetmultiplayeractivitygameinviteuiresponse)   | XGameUiShowMultiplayerActivityGameInviteAsync 呼び出しを完了します。                                                                 |
| [XGameUISetErrorDialogUIResponse](/reference/system/xgameui/functions/xgameuiseterrordialoguiresponse)                                       | XGameUiShowErrorDialogAsync 呼び出しを完了します。                                                                                   |
| [XGameUIShowPlayerProfileCardUICallback](/reference/system/xgameui/functions/xgameuishowplayerprofilecarduicallback)                         | XGameUiShowPlayerProfileCardAsync コールバックのシグネチャ。                                                                           |
| [XGameUIShowPlayerPickerUICallback](/reference/system/xgameui/functions/xgameuishowplayerpickeruicallback)                                   | XGameUiShowPlayerPickerAsync コールバックのシグネチャ。                                                                                |
| [XGameUIShowSendGameInviteUICallback](/reference/system/xgameui/functions/xgameuishowsendgameinviteuicallback)                               | XGameUiShowSendGameInviteAsync コールバックのシグネチャ。                                                                              |
| [XGameUIShowAchievementsUICallback](/reference/system/xgameui/functions/xgameuishowachievementsuicallback)                                   | XGameUiShowAchievementsAsync コールバックのシグネチャ。                                                                                |
| [XGameUIShowMultiplayerActivityGameInviteUICallback](/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteuicallback) | XGameUiShowMultiplayerActivityGameInviteAsync コールバックのシグネチャ。                                                               |
| [XGameUIShowMessageDialogUICallback](/reference/system/xgameui/functions/xgameuishowmessagedialoguicallback)                                 | XGameUiShowMessageDialogAsync コールバックのシグネチャ。                                                                               |
| [XGameUIShowErrorDialogUICallback](/reference/system/xgameui/functions/xgameuishowerrordialoguicallback)                                     | XGameUiShowErrorDialogAsync コールバックのシグネチャ。                                                                                 |
| [XGameUIShowTextEntryUICallback](/reference/system/xgameui/functions/xgameuishowtextentryuicallback)                                         | XGameUiShowTextEntryAsync コールバックのシグネチャ。                                                                                   |

## 構造体

| 構造体                                                                                                        | 説明                                                             |
| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| [XGameUiWebAuthenticationResultData](/reference/system/xgameui/structs/xgameuiwebauthenticationresultdata) | Web 認証要求からの応答が含まれます。                                           |
| [XGameUiTextEntryExtents](/reference/system/xgameui/structs/xgameuitextentryextents)                       | 仮想キーボードの相対的な配置を記述します。                                          |
| [XGameUiTextEntryOptions](/reference/system/xgameui/structs/xgameuitextentryoptions)                       | XGameUiTextEntryOpen で使用される仮想キーボードの初期オプション セット。                |
| [XGameUICallbackHandle](/reference/system/xgameui/structs/xgameuicallbackhandle)                           | XGameUi コールバック呼び出しに関連付けられたハンドル。Set\*Response API の呼び出しで使用されます。 |
| [XGameUIPlayerPickerInfo](/reference/system/xgameui/structs/xgameuiplayerpickerinfo)                       | 開発者のカスタム プレイヤー ピッカー UI で使用するユーザー情報をカプセル化する構造体。                 |
| [XGameUIUICallbacks](/reference/system/xgameui/structs/xgameuiuicallbacks)                                 | 開発者が定義した UI コールバックへのポインターを含む構造体。                               |

## 列挙型

| 列挙型                                                                                                | 説明                                                 |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| [XGameUiMessageDialogButton](/reference/system/xgameui/enums/xgameuimessagedialogbutton)           | カスタマイズ可能なメッセージ ダイアログ ボックス内のボタンを列挙します。              |
| [XGameUiNotificationPositionHint](/reference/system/xgameui/enums/xgameuinotificationpositionhint) | 現在のタイトルでトースト通知を表示する推奨位置を記述します。                     |
| [XGameUiTextEntryChangeTypeFlags](/reference/system/xgameui/enums/xgameuitextentrychangetypeflags) | XGameUiTextEntryGetState の最後の呼び出しから何が変更されたかを示すフラグ。 |
| [XGameUiTextEntryInputScope](/reference/system/xgameui/enums/xgameuitextentryinputscope)           | テキスト エントリで想定される情報の種類を列挙します。                        |
| [XGameUiTextEntryPositionHint](/reference/system/xgameui/enums/xgameuitextentrypositionhint)       | 仮想キーボードを配置するのに最適な場所のヒント。                           |
| [XGameUiTextEntryVisibilityFlags](/reference/system/xgameui/enums/xgameuitextentryvisibilityflags) | 仮想キーボードの表示状態を示すフラグ。                                |
| [XGameUiWebAuthenticationOptions](/reference/system/xgameui/enums/xgameuiwebauthenticationoptions) | Web 認証フローを表示するオプションを列挙します。                         |

## エラー コード

XGameUI API から次のエラー コードが返される場合があります。完全な一覧については、[Error codes](/reference/errorcodes) を参照してください。

| コード                              | 値 | 説明                                                                                                                                       |
| -------------------------------- | - | ---------------------------------------------------------------------------------------------------------------------------------------- |
| E\_GAMEUI\_TEXTENTRY\_NOT\_SHOWN | — | XGameUiTextEntryHandle が有効ではありません。おそらく最初に [XGameUiTextEntryOpen](/reference/system/xgameui/functions/xgameuitextentryopen) を呼び出す必要があります。 |

## 概念ドキュメント

* [非同期プログラミングの設計目標と改善点](/build/core-features/common/async/async-whitepaper)
* [Time-sensitive threads](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)
* [What is the Microsoft Game Development Kit?](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/intro/introduction)
* [Using C# wrappers for GDK APIs in your Unity project](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/pc-dev/tutorials/get-started-with-unity-pc/features/gdk-unity-api-wrappers)

## 関連項目

[システム API リファレンス](/reference/system/gc-reference-system-toc)


## Related topics

- [XGameUiShowSendGameInviteResult](/ja-jp/reference/system/xgameui/functions/xgameuishowsendgameinviteresult.md)
- [XGameUiShowSendGameInviteAsync](/ja-jp/reference/system/xgameui/functions/xgameuishowsendgameinviteasync.md)
- [XGameUiSetSendGameInviteUiResponse](/ja-jp/reference/system/xgameui/functions/xgameuisetsendgameinviteuiresponse.md)
- [XGameUiUiCallbacks](/ja-jp/reference/system/xgameui/structs/xgameuiuicallbacks.md)
- [XGameUiShowSendGameInviteUiCallback](/ja-jp/reference/system/xgameui/functions/xgameuishowsendgameinviteuicallback.md)
