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

## 構造体

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

## 列挙型

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

## エラー コード

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

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

## 概念ドキュメント

* [非同期プログラミングの設計目標と改善点](https://docs.xbox.com/ja-jp/build/core-features/common/async/async-whitepaper.md)
* [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 リファレンス](https://docs.xbox.com/ja-jp/reference/system/gc-reference-system-toc.md)


## Related topics

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