XtfWaitForConsoleOSReady
本体 OS がコマンドを受信する準備ができるまで待機してから復帰します。
構文
HRESULT XtfWaitForConsoleOSReady(
PCWSTR address,
UINT32 timeoutMS
)
パラメーター
address
型: PCWSTR
[in] 本体のアドレス。 アドレスがシステムの IP アドレスまたはホスト名である場合は、システム OS の準備ができるまで API がブロックされます。 アドレスに /title が含まれる (例: L"123.12.123.24/title") 場合は、ゲーム OS が起動するまで API がブロックされます。
timeoutMS
型: UINT32
[in] タイムアウト (ミリ秒単位)。
戻り値
型: HRESULT
成功した場合は S_OK を返します。 タイムアウト時間が経過する前に OS の準備ができていない場合は、XtfWaitForConsoleOSReady が ERROR_TIMEOUT を返します。 指定されたアドレスが有効でない場合は、XtfWaitForConsoleOSReady が E_INVALIDARG を返します。
解説
次の表に、本体の状態に基づいてこの API がどのように動作するかの例を示します。
状態 |
アクション |
結果 |
---|---|---|
システムが起動して実行中 | XtfWaitForConsoleOSReady | すぐに S_OK が返されます。 |
システムが起動して実行中 |
| 本体が完全に再起動するまで XtfWaitForConsoleOSReady がブロックされます。 起動が成功すると、ホーム内に制限されて起動されるのではなく、全画面表示で起動されます。 |
システムがオフ | XtfWaitForConsoleOSReady | XtfWaitForConsoleOSReady は、タイムアウトまでブロックされ、エラーを返します。 |
システムがオフ |
| 本体が完全に起動するまで XtfWaitForConsoleOSReady がブロックされます。 起動が成功すると、ホーム内に制限されて起動されるのではなく、全画面表示で起動されます。 |
要件
ヘッダー: xtfapi.h
ライブラリ: XtfApi.lib
サポートされているプラットフォーム: Windows (Xbox 本体ツール用)
関連項目
XtfRegisterPackage
XTF トランスポート エラー (NDA トピック)認可が必須です
その他の Xtf API