XtfWaitForConsoleState
指定された本体の状態に達するか、タイムアウトが発生するまでブロックが実行されます。
構文
HRESULT XtfWaitForConsoleState(
PCWSTR address,
UINT32 consoleState,
const UINT32 timeoutMS
)
パラメーター
address
型: PCWSTR
[in] 本体のアドレス。
consoleState
型: UINT32
[in] 本体の現在の状態を示すフラグのビット単位の OR の組み合わせ。 このパラメーターは次のフラグをサポートします。
| フラグ | 値 | 説明 |
|---|---|---|
| XTF_SYSTEM_OS_READY | 0x0001 | システム OS は、用意されている Xbox Tools Framework (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 で指定された状態と比較して検証します。
consoleState で指定された状態が timeoutMS で指定された時間内に本体の状態と一致しない場合、この関数は ERROR_TIMEOUT を返します。それ以外の場合、この関数はループを停止し、S_OK を返します。 システム OS とゲーム OS の詳細については、「Microsoft Game Development Kit とは?認可が必須です」を参照してください。
要件
ヘッダー: xtfapi.h
ライブラリ: XtfApi.lib
サポートされているプラットフォーム: Windows (Xbox 本体ツール用)