XGameUiShowTextEntryAsync

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

構文

HRESULT XGameUiShowTextEntryAsync(  
         XAsyncBlock* async,  
         const char* titleText,  
         const char* descriptionText,  
         const char* defaultText,  
         XGameUiTextEntryInputScope inputScope,  
         uint32_t maxTextLength  
)  

パラメーター

async _In_
型: XAsyncBlock*

XAsyncRun に渡された XAsyncBlock へのポインター。

titleText _In_opt_z_
型: char*

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

descriptionText _In_opt_z_
型: char*

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

defaultText _In_opt_z_
型: char*

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

inputScope _In_
型: XGameUiTextEntryInputScope

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

maxTextLength _In_
型: uint32_t

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

戻り値

型: HRESULT

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

結果を取得するには、AsyncBlock コールバック内で、または AsyncBlock 完了後に、XGameUiShowTextEntryResultSize と XGameUiShowTextEntryResult を呼び出します。

解説

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

UI を呼び出すと、ゲームが制限モードに入ります。 制限モードでは、呼び出された UI のバックグラウンドにある間、タイトルが受け取るシステム リソースが少なくなります。 タイトルの制限モードや他の操作モードの詳細については、「Xbox ゲーム ライフ サイクル (NDA トピック)認可が必須です」をお読みください。

要件

ヘッダー: XGameUI.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XGameUI
Virtual keyboard supportXGameUIShowTextEntryResult
XGameUIShowTextEntryResultSize
Xbox ゲーム ライフ サイクル (NDA トピック)認可が必須です