XGameUiTextEntryGetState
開いている仮想キーボードの現在の状態を取得します。Syntax
Parameters
handle _In_型: XGameUiTextEntryHandle 開いている仮想キーボードへのハンドル。 changeType _Out_
型: XGameUiTextEntryChangeTypeFlags* ゲームが XGameUiTextEntryGetState を最後に呼び出してから、テキストが変更されたか、仮想キーボードが 閉じられたかを示します。変更の種類が仮想キーボードが閉じられたことを示している場合、ゲームはテキストの 変更処理が完了した時点で XGameUiTextEntryClose を呼び出す必要があります。 cursorIndex _Out_opt_
型: uint32_t* 先頭文字を基準としたカーソルのバイト インデックス。 imeClauseStartIndex _Out_opt_
型: uint32_t* IME 候補で置き換えられる可能性がある IME 文節の開始バイト インデックス。この値はカーソル インデックスより前になります。 IME が使用されていない場合、この値はゼロになります。 imeClauseEndIndex _Out_opt_
型: uint32_t* IME 候補で置き換えられる可能性がある IME 文節の終了バイト インデックス。この値はカーソル インデックスより後になります。 IME が使用されていない場合、この値はゼロになります。 bufferSize _In_
型: uint32_t 仮想キーボードからのテキストを受け取るゲーム提供バッファーのサイズ (バイト単位)。 buffer _Out_
型: char* 仮想キーボードに入力された完全なテキスト (null 終端文字列)。改行は ‘\n’ として表されます。
Return value
型: HRESULT HRESULT の成功またはエラー コード。エラー コードの一覧については、Error Codes を参照してください。Remarks
この関数は、最新の仮想キーボードの変更を取得するために、フレームごとに少なくとも 1 回呼び出す必要があります。 キーボードが後で閉じられた場合、関数は正常に返りますが、変更の種類には KeyboardDismissed が含まれます。Requirements
ヘッダー: XGameUI.h ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、XBOX One ファミリー本体および XBOX Series 本体See also
XGameUIXGameUiTextEntryOpen XGameUiTextEntryClose