XGameUiTextEntryGetExtents

Gets the screen extents of the virtual keyboard so that callers know where it is safe to render text.

Syntax

HRESULT XGameUiTextEntryGetExtents(  
         XGameUiTextEntryHandle handle,
         XGameUiTextEntryExtents* extents
)  

Parameters

handle   _In_
Type: XGameUiTextEntryHandle

Handle to the currently open virtual keyboard.

handle   _Out_
Type: XGameUiTextEntryExtents

Describe the screen extents of the virtual keyboard.

Return value

Type: HRESULT

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

Remarks

This function will always return the extents of the large accessibility keyboard if the full keyboard is visible. Otherwise, it will return the extents of the candidate list.

Requirements

Header: XGameUI.h

Library: xgameruntime.lib

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

See also

XGameUI