XGameUiTextEntryGetState

開いている仮想キーボードの現在の状態を取得します。

構文

HRESULT XGameUiTextEntryGetState(  
         XGameUiTextEntryHandle handle,
         XGameUiTextEntryChangeTypeFlags* changeType,
         uint32_t* cursorIndex,
         uint32_t* imeClauseStartIndex,
         uint32_t* imeClauseEndIndex,
         uint32_t bufferSize,
         char* buffer
)  

パラメーター

handle _In_
型: XGameUiTextEntryHandle

開いている仮想キーボードへのハンドル。

changeType _Out_
型: XGameUiTextEntryChangeTypeFlags*

ゲームで最後に XGameUiTextEntryGetState を呼び出してからテキストが変更されたか、仮想キーボードが閉じられたかどうかを説明します。 仮想キーボードが閉じられたことを変更の種類が示している場合は、テキストの変更の処理が完了したら、ゲームで XGameUiTextEntryClose を呼び出す必要があります。

cursorIndex _Out_opt_
型: uint32_t*

開始文字を基準としたカーソルのバイト インデックス。

imeClauseStartIndex _Out_opt_
型: uint32_t*

IME 候補に置き換えられる可能性がある IME 句の開始バイト インデックス。 これは、カーソル インデックスの前になります。 IME が使用されていない場合、この値は 0 になります。

imeClauseEndIndex _Out_opt_
型: uint32_t*

IME 候補に置き換えられる可能性がある IME 句の終了バイト インデックス。 これは、カーソル インデックスの後になります。 IME が使用されていない場合、この値は 0 になります。

bufferSize _In_
型: uint32_t

仮想キーボードからテキストを取得するゲーム提供バッファーのサイズ (バイト単位)。

buffer _Out_
型: char*

null で終わる文字列として仮想キーボードに入力された完全なテキスト。 改行は 'n' として表されます。

戻り値

型: HRESULT

HRESULT 成功またはエラー コード。 エラー コードの一覧については、「エラー コード」を参照してください。

リターン コード	説明
S_OK	操作に成功しました。
E_GAMEUI_TEXTENTRY_NOT_SHOWN	XGameUiTextEntryOpen を呼び出す必要がある可能性があるため、XGameUiTextEntryHandle が無効です。

解説

最新の仮想キーボードの変更を取得するには、この関数をフレームごとに少なくとも 1 回呼び出す必要があります。 後でキーボードを閉じると、関数は正常に返されます。ただし、変更の種類には KeyboardDismissed が含まれます。

要件

ヘッダー: XGameUI.h

ライブラリ: xgameruntime.lib

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

関連項目

XGameUI
XGameUiTextEntryOpenXGameUiTextEntryClose