XtfWaitForConsoleOSReady

在返回前一直等待,直到主机操作系统准备好接收命令。

语法

HRESULT XtfWaitForConsoleOSReady(
         PCWSTR address,
         UINT32 timeoutMS
)  

参数

address
类型:PCWSTR

[in] 主机的地址。 如果地址为系统 IP 地址或 HostName,在系统操作系统准备好之前将阻止 API。 如果地址包含 /title(例如 L"123.12.123.24/title"),则在游戏操作系统启动前将阻止 API。

timeoutMS
类型:UINT32

[in] 超时值(毫秒)。

返回值

类型:HRESULT

成功时返回 S_OK。 如果在超时到来前操作系统未准备好,XtfWaitForConsoleOSReady 将返回 ERROR_TIMEOUT。 如果指定的地址无效,XtfWaitForConsoleOSReady 将返回 E_INVALIDARG。

备注

下表显示此 API 基于主机状态的行为方式的示例。

状态

操作

结果

系统正在运行XtfWaitForConsoleOSReady立即返回 S_OK
系统正在运行
  • XtfConsoleControlClient::Reboot
  • XtfWaitForConsoleOSReady
  • XtfApplicationClient::Launch
阻止 XtfWaitForConsoleOSReady 直到主机完全重新启动。 启动成功且全屏显示,而不是将启动内容限制为主屏幕。
系统关闭XtfWaitForConsoleOSReady阻止 XtfWaitForConsoleOSReady 达到超时并返回错误。
系统关闭
  • XtfWaitForConsoleOSReady
  • 开启主机
  • XtfApplicationClient::Launch
阻止 XtfWaitForConsoleOSReady 直到主机完全启动。 启动成功且全屏显示,而不是将启动内容限制为主屏幕。

要求

头文件:xtfapi.h

库:XtfApi.lib

支持平台:Windows(适用于 Xbox 主机工具)

另请参阅

XtfRegisterPackage
XTF 传输错误(NDA 主题)要求授权
其他 Xtf API