XGameUiTextEntryGetState
取得已開啟虛擬鍵盤的目前狀態。語法
參數
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’ 表示。
傳回值
類型：HRESULT HRESULT 成功或錯誤碼。如需錯誤碼清單，請參閱錯誤碼。備註
此函式每個畫面格至少需要呼叫一次，才能取得最新的虛擬鍵盤變更。 如果鍵盤稍後被關閉，此函式會成功傳回；不過，變更類型 會包含 KeyboardDismissed。需求
標頭： XGameUI.h 程式庫： xgameruntime.lib 支援的平台： Windows、XBOX One 系列主機和 XBOX Series 主機另請參閱
XGameUIXGameUiTextEntryOpen XGameUiTextEntryClose