> ## 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.

# XGameUiShowTextEntryAsync

> XGameUiShowTextEntryAsync

# XGameUiShowTextEntryAsync

ユーザーが情報を入力するためのテキスト入力 UI を表示します。

## 構文

```cpp theme={null}
HRESULT XGameUiShowTextEntryAsync(  
         XAsyncBlock* async,  
         const char* titleText,  
         const char* descriptionText,  
         const char* defaultText,  
         XGameUiTextEntryInputScope inputScope,  
         uint32_t maxTextLength  
)  
```

### パラメーター

*async*   \_In\_\
Type: [XAsyncBlock\*](https://docs.xbox.com/ja-jp/reference/system/xasync/structs/xasyncblock.md)

[XAsyncRun](https://docs.xbox.com/ja-jp/reference/system/xasync/functions/xasyncrun.md) に渡される [XAsyncBlock](https://docs.xbox.com/ja-jp/reference/system/xasync/structs/xasyncblock.md) へのポインター。

*titleText*   \_In\_opt\_z\_\
Type: char\*

テキスト入力 UI のテキスト タイトル。

*descriptionText*   \_In\_opt\_z\_\
Type: char\*

テキスト入力 UI のテキストの説明。

*defaultText*   \_In\_opt\_z\_\
Type: char\*

テキスト入力 UI に最初に表示される既定のテキスト。

*inputScope*   \_In\_\
Type: [XGameUiTextEntryInputScope](https://docs.xbox.com/ja-jp/reference/system/xgameui/enums/xgameuitextentryinputscope.md)

テキスト入力の入力スコープを指定し、許可される情報の種類を示します。このスコープは、ゲームで想定されるテキストに関するヒントを提供します。ゲームはキーボードから取得したテキストを引き続き検証する必要があります。

*maxTextLength*   \_In\_\
Type: uint32\_t

ユーザーがテキスト入力 UI に入力できる最大文字数。本体では最大文字数は 1024 です。PC では制限はありません。値 0 が渡された場合、最大文字数は 1024 として扱われます。さらに、*inputScope* が XGameUiTextEntryInputScope::Password の場合、最大長は常に 1024 であり、*maxTextLength* の値は無視されます。

### 戻り値

Type: HRESULT

非同期呼び出しの HRESULT 成功またはエラー コード。

結果を取得するには、*AsyncBlock* コールバック内または *AsyncBlock* の完了後に [XGameUiShowTextEntryResultSize](https://docs.xbox.com/ja-jp/reference/system/xgameui/functions/xgameuishowtextentryresultsize.md) および [XGameUiShowTextEntryResult](https://docs.xbox.com/ja-jp/reference/system/xgameui/functions/xgameuishowtextentryresult.md) を呼び出します。

## 解説

コンソールでは、テキスト入力フィールドと画面上の仮想キーボード (OSK) の両方が表示されます。Windows では、テキスト入力フィールドを備えた新しいウィンドウが表示されます。物理キーボードを使用するのではなく、画面上のキーボードを使用するように構成されている場合 (タブレット モードなど) にのみ、Windows で仮想キーボードが表示されます。

UI を呼び出すと、ゲームは *制約付きモード* に入ります。制約付きモードでは、呼び出された UI のバックグラウンドにある間、タイトルが受け取るシステム リソースが少なくなります。制約付きモードやタイトルのその他の運用モードの詳細については、「[XBOX ゲーム ライフ サイクル (NDA トピック)](https://docs.xbox.com/ja-jp/build/console-features/console-workflows/xbox-game-life-cycle.md)」を参照してください。

## 要件

**ヘッダー:** XGameUI.h

**ライブラリ:** xgameruntime.lib

**サポートされているプラットフォーム:** Windows、Steam Deck、XBOX One ファミリー本体および XBOX Series 本体

## 関連項目

[XGameUI](https://docs.xbox.com/ja-jp/reference/system/xgameui/xgameui_members.md)\
[仮想キーボードのサポート](https://docs.xbox.com/ja-jp/build/core-features/common/input/overviews/virtualkeyboardsupport.md) [XGameUIShowTextEntryResult](https://docs.xbox.com/ja-jp/reference/system/xgameui/functions/xgameuishowtextentryresult.md)\
[XGameUIShowTextEntryResultSize](https://docs.xbox.com/ja-jp/reference/system/xgameui/functions/xgameuishowtextentryresultsize.md)\
[XBOX ゲーム ライフ サイクル (NDA トピック)](https://docs.xbox.com/ja-jp/build/console-features/console-workflows/xbox-game-life-cycle.md)


## Related topics

- [XGameUiShowTextEntryResult](https://docs.xbox.com/ja-jp/reference/system/xgameui/functions/xgameuishowtextentryresult.md)
- [XGameUiShowTextEntryUiCallback](https://docs.xbox.com/ja-jp/reference/system/xgameui/functions/xgameuishowtextentryuicallback.md)
- [XGameUiShowTextEntryResultSize](https://docs.xbox.com/ja-jp/reference/system/xgameui/functions/xgameuishowtextentryresultsize.md)
- [XGameUiSetTextEntryUiResponse](https://docs.xbox.com/ja-jp/reference/system/xgameui/functions/xgameuisettextentryuiresponse.md)
- [XGameUiTextEntryInputScope](https://docs.xbox.com/ja-jp/reference/system/xgameui/enums/xgameuitextentryinputscope.md)