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

# XInputEnable

> XInputEnable

# XInputEnable

设置 XInput 的报告状态。

## 语法

```cpp theme={null}
void XInputEnable(  
         BOOL enable  
)  
```

### 参数

*enable*   \_In\_\
类型：BOOL

如果 enable 为 **FALSE**，XInput 在响应 [XInputGetState](/reference/input/xinputongameinput/functions/xinputgetstate) 时只会发送中性数据：即所有按钮为释放状态，轴居中，扳机值为 0。对 [XInputSetState](/reference/input/xinputongameinput/functions/xinputsetstate) 的调用会被记录，但不会发送到设备。发送任何非 **FALSE** 的值都会恢复正常的读写功能。

### 返回值

类型：void

无。

## 备注

此函数已弃用，不应写入任何新代码中。XInputEnable 会为许多 XInput 包装器调用增加开销。你可以 `#define XINPUT_ON_GAMEINPUT_NO_XINPUTENABLE` 来消除 XInputEnable 及其产生的开销。有关详细信息，请参见 [从 XInput 迁移到 GameInput](/build/core-features/common/input/porting/input-porting-xinput#optimizingSection)。

此函数旨在在应用程序获得或失去焦点时调用。使用此函数时，你无需更改应用程序中的 XInput 查询循环，因为如果 XInput 被禁用，则始终会报告中性数据。

在支持震动效果的控制器中：

* 传递 **FALSE** 会停止当前正在播放的任何震动效果。在此状态下，对 [XInputSetState](/reference/input/xinputongameinput/functions/xinputsetstate) 的调用会被记录，但不会传递到设备。
* 传递 **TRUE** 会将最后一次发送到 [XInputSetState](/reference/input/xinputongameinput/functions/xinputsetstate) 的震动请求（即使值为 0）传递给设备。

## 要求

**头文件：** XInputOnGameInput.h

**库：** xgameruntime.lib

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

## 另请参阅

[将 XInput 迁移到 GameInput](/build/core-features/common/input/porting/input-porting-xinput)\
[XInputOnGameInput](/reference/input/xinputongameinput/xinputongameinput_members)\
[XInputGetState](/reference/input/xinputongameinput/functions/xinputgetstate)\
[XInputSetState](/reference/input/xinputongameinput/functions/xinputsetstate)


## Related topics

- [XInputOnGameInput](/zh-CN/reference/input/xinputongameinput/xinputongameinput_members.md)
- [从 XInput 移植到 GameInput](/zh-CN/build/core-features/common/input/porting/input-porting-xinput.md)
- [IGameInput::EnableOemDeviceSupport](/zh-CN/reference/input/gameinput/deprecated/interfaces/igameinput/methods/igameinput_enableoemdevicesupport.md)
- [XGameStreamingIsTouchInputEnabled](/zh-CN/reference/system/xgamestreaming/functions/xgamestreamingistouchinputenabled.md)
- [已弃用的 GameInput API 成员](/zh-CN/reference/input/gameinput/deprecated/gameinput_deprecated_members.md)