> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XGameUiTextEntryGetState

> XGameUiTextEntryGetState

# XGameUiTextEntryGetState

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

## Syntax

```cpp theme={null}
HRESULT XGameUiTextEntryGetState(  
         XGameUiTextEntryHandle handle,
         XGameUiTextEntryChangeTypeFlags* changeType,
         uint32_t* cursorIndex,
         uint32_t* imeClauseStartIndex,
         uint32_t* imeClauseEndIndex,
         uint32_t bufferSize,
         char* buffer
)  
```

### Parameters

*handle*   \_In\_\
型: XGameUiTextEntryHandle

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

*changeType*   \_Out\_\
型: [XGameUiTextEntryChangeTypeFlags\*](/reference/system/xgameui/enums/xgameuitextentrychangetypeflags)

ゲームが *XGameUiTextEntryGetState* を最後に呼び出してから、テキストが変更されたか、仮想キーボードが
閉じられたかを示します。変更の種類が仮想キーボードが閉じられたことを示している場合、ゲームはテキストの
変更処理が完了した時点で [XGameUiTextEntryClose](/reference/system/xgameui/functions/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](/reference/errorcodes) を参照してください。

| 戻り値                              | 説明                                                                        |
| -------------------------------- | ------------------------------------------------------------------------- |
| S\_OK                            | 操作が成功しました。                                                                |
| E\_GAMEUI\_TEXTENTRY\_NOT\_SHOWN | XGameUiTextEntryHandle が有効ではありません。おそらく XGameUiTextEntryOpen を呼び出す必要があります。 |

## Remarks

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

## Requirements

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

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

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

## See also

[XGameUI](/reference/system/xgameui/xgameui_members)\
[XGameUiTextEntryOpen](/reference/system/xgameui/functions/xgameuitextentryopen)
[XGameUiTextEntryClose](/reference/system/xgameui/functions/xgameuitextentryclose)


## Related topics

- [XGameUiTextEntryChangeTypeFlags](/ja-jp/reference/system/xgameui/enums/xgameuitextentrychangetypeflags.md)
- [XGameUI](/ja-jp/reference/system/xgameui/xgameui_members.md)
- [XGameUiTextEntryGetExtents](/ja-jp/reference/system/xgameui/functions/xgameuitextentrygetextents.md)
- [XGameUiTextEntryExtents](/ja-jp/reference/system/xgameui/structs/xgameuitextentryextents.md)
- [XGameUiShowTextEntryUiCallback](/ja-jp/reference/system/xgameui/functions/xgameuishowtextentryuicallback.md)