XGameUiTextEntryUpdateVisibility

Updates whether to show the full virtual keyboard or only the candidate list.

Syntax

HRESULT XGameUiTextEntryUpdateVisibility(  
         XGameUiTextEntryHandle handle,
         XGameUiTextEntryVisibilityFlags visibilityFlags, 
)  

Parameters

handle   _In_
Type: XGameUiTextEntryHandle

Handle to the opened virtual keyboard.

visibilityFlags   _In_
Type: XGameUiTextEntryVisibilityFlags

Flags indicating whether to show the full virtual keyboard or only the candidate list.

Return value

Type: HRESULT

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

Remarks

Generally, the game should only use this function to toggle the candidate-only view if there is a physical keyboard is being used by the game.

Requirements

Header: XGameUI.h

Library: xgameruntime.lib

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

See also

XGameUI