XtfWaitForConsoleOSReady
Waits until the console OS is ready to receive commands before returning.
Syntax
HRESULT XtfWaitForConsoleOSReady(
PCWSTR address,
UINT32 timeoutMS
)
Parameters
address
Type: PCWSTR
[in] Address of the console. If address is the System IP address or HostName, the API will block until the System OS is ready. If the address includes /title (for example L"123.12.123.24/title") then the API will block until the Game OS has started.
timeoutMS
Type: UINT32
[in] Timeout in milliseconds.
Return value
Type: HRESULT
Returns S_OK on success. If the OS is not ready before the timeout has expired, XtfWaitForConsoleOSReady returns ERROR_TIMEOUT. If the specified address is not valid XtfWaitForConsoleOSReady returns E_INVALIDARG.
Remarks
The following table shows examples of how this API behaves based on the state of the console.
State |
Action |
Result |
---|---|---|
System is up and running | XtfWaitForConsoleOSReady | Return S_OK immediately |
System is up and running |
| XtfWaitForConsoleOSReady blocks until the console fully reboots. Launch is successful and launches full screen instead of getting launched constrained into home. |
System is off | XtfWaitForConsoleOSReady | XtfWaitForConsoleOSReady blocks for timeout and returns an error. |
System is off |
| XtfWaitForConsoleOSReady blocks until the console fully boots. Launch is successful and launches full screen instead of getting launched constrained into home. |
Requirements
Header: xtfapi.h
Library: XtfApi.lib
Supported platforms: Windows (for Xbox console tools)
See also
XtfRegisterPackage
XTF Transport Errors (NDA topic)Autorisation obligatoire
Additional Xtf APIs