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	XGameUiTextEntryHandle이 유효하지 않습니다. XGameUiTextEntryOpen을 호출해야 하기 때문일 수 있습니다.

설명

최신 가상 키보드 변경 사항을 가져오려면 이 함수를 프레임당 한 번 이상 호출해야 합니다. 나중에 키보드를 닫으면 함수가 성공적으로 반환됩니다. 그러나 변경 유형에는 KeyboardDismissed가 포함됩니다.

요구 사항

헤더: XGameUI.h

라이브러리: xgameruntime.lib

지원되는 플랫폼: Windows, Xbox One 패밀리 콘솔 및 Xbox Series 콘솔

참고 항목

XGameUI
XGameUiTextEntryOpenXGameUiTextEntryClose