> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XGameUiTextEntryGetExtents

> XGameUiTextEntryGetExtents

# XGameUiTextEntryGetExtents

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

## Syntax

```cpp theme={null}
HRESULT XGameUiTextEntryGetExtents(  
         XGameUiTextEntryHandle handle,
         XGameUiTextEntryExtents* extents
)  
```

### Parameters

*handle*   \_In\_\
Type: XGameUiTextEntryHandle

Handle to the currently open virtual keyboard.

*handle*   \_Out\_\
Type: [XGameUiTextEntryExtents](/reference/system/xgameui/structs/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](/reference/errorcodes).

## 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](/reference/system/xgameui/xgameui_members)


## Related topics

- [XGameUiTextEntryExtents](/reference/system/xgameui/structs/xgameuitextentryextents.md)
- [XGameUI](/reference/system/xgameui/xgameui_members.md)
- [XGameUiTextEntryGetState](/reference/system/xgameui/functions/xgameuitextentrygetstate.md)
- [XGameUiTextEntryOpen](/reference/system/xgameui/functions/xgameuitextentryopen.md)
- [XGameUiShowTextEntryAsync](/reference/system/xgameui/functions/xgameuishowtextentryasync.md)