XGameUiTextEntryClose

Closes the virtual keyboard and frees up the corresponding resources.

Syntax

HRESULT XGameUiTextEntryClose(  
         XGameUiTextEntryHandle handle  
)  

Parameters

handle   _In_
Type: XGameUiTextEntryHandle

Handle to the currently open virtual keyboard.

Return value

Type: HRESULT

HRESULT success or error code. For a list of error codes, see Error Codes.

Remarks

Games should call XGameUiTextEntryClose when they are done with collecting input or in response to the keyboard having been dismissed.

Requirements

Header: XGameUI.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

XGameUI
XGameUiTextEntryOpen