在达到指定的主机状态或者发生超时前一直执行阻止。
语法
HRESULT XtfWaitForConsoleState(
PCWSTR address,
UINT32 consoleState,
const UINT32 timeoutMS
)
参数
address
类型：PCWSTR
[in] 主机的地址。
consoleState
类型：UINT32
[in] 标志的按位或组合，指示主机的当前状态。 此参数支持以下标志：
| 标志 | 值 | 描述 |
|---|---|---|
| XTF_SYSTEM_OS_READY | 0x0001 | 系统 OS 已准备好进行 Xbox 工具框架 (XTF) 通信。 |
| XTF_TITLE_OS_READY | 0x0002 | 游戏 OS 已准备好进行 XTF 通信。<br>此标志等效于 XtfGetTitleOSState 函数返回的 XTF_TITLESTATE_TITLEOSRUNNING 和 XTF_TITLESTATE_TITLENETWORK_READY 标志。 |
| XTF_TITLE_PROCESS_READY | 0x0004 | 游戏的进程已准备好进行 XTF 通信。<br>此标志等效于 XtfGetTitleOSState 函数返回的 XTF_TITLESTATE_TITLERUNNING 标志。 |
timeoutMS
类型：UINT32
[in] 函数返回 ERROR_TIMEOUT 之前的超时时间（以毫秒为单位）。
返回值
类型：HRESULT
如果成功，返回 S_OK；否则返回以下的 HRESULT 错误代码之一。
| 错误代码 | 描述 |
|---|---|
| ERROR_TIMEOUT | timeoutMS 中指定的超时时间已过，并且未达到 consoleState 中指定的状态。 |
| E_INVALIDARG | 传入 address 或 consoleState 的值无效。 |
备注
此函数每隔 250 毫秒循环一次，从而根据 consoleState 中指定的状态验证主机的当前状态。 如果在 timeoutMS中指定的时间内，consoleState 中指定的状态与主机的当前状态不符，此函数则返回 ERROR_TIMEOUT；否则，此函数会停止循环并返回 S_OK。 有关系统 OS 和游戏 OS 的详细信息，请参阅《有关完整介绍，请参阅什么是 Microsoft 游戏开发工具包？（NDA 主题）》。
要求
头文件：xtfapi.h
库：XtfApi.lib
支持平台：Windows（适用于 Xbox 主机工具）