> ## 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

获取虚拟键盘的屏幕范围，以便调用方知道在何处渲染文本是安全的。

## 语法

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

### 参数

*handle*   \_In\_\
类型：XGameUiTextEntryHandle

当前打开的虚拟键盘的句柄。

*handle*   \_Out\_\
类型：[XGameUiTextEntryExtents](/reference/system/xgameui/structs/xgameuitextentryextents)

描述虚拟键盘的屏幕范围。

### 返回值

类型：HRESULT

HRESULT 成功或错误代码。有关错误代码列表，请参阅[错误代码](/reference/errorcodes)。

## 备注

如果完整键盘可见，此函数将始终返回大型辅助功能键盘的范围。否则，将返回候选列表的范围。

## 要求

**标头：** XGameUI.h

**库：** xgameruntime.lib

**支持的平台：** Windows、XBOX One 系列主机和 XBOX Series 主机

## 请参阅

[XGameUI](/reference/system/xgameui/xgameui_members)


## Related topics

- [XGameUiTextEntryExtents](/zh-CN/reference/system/xgameui/structs/xgameuitextentryextents.md)
- [XGameUI](/zh-CN/reference/system/xgameui/xgameui_members.md)
- [XGameUiTextEntryGetState](/zh-CN/reference/system/xgameui/functions/xgameuitextentrygetstate.md)
- [XGameUiTextEntryChangeTypeFlags](/zh-CN/reference/system/xgameui/enums/xgameuitextentrychangetypeflags.md)
- [XGameUiSetTextEntryUiResponse](/zh-CN/reference/system/xgameui/functions/xgameuisettextentryuiresponse.md)