XtfGetTitleOSState

[アーティクル]
05/10/2023

状態、プロセス ID、パッケージのフルネーム、アプリケーションユーザーモデル ID (AUMID) などの実行中のゲームの情報を取得します。

構文

HRESULT XtfGetTitleOSState(
        PCWSTR address,
        UINT32* titleStateFlags,
        UINT32* pid,
        PWSTR packageFullName,
        UINT32* packageFullNameLength,
        PWSTR aumid,
        UINT32* aumidLength)

パラメーター

address
型: PCWSTR

[in] 本体のアドレス。

titleStateFlags
型: UINT32*

[out, optional] ゲームに関する追加情報を提供するフラグのビットごとの OR の組み合わせ。この値が必要ない場合は、nullptr に設定します。このパラメーターは次のフラグをサポートします。

フラグ	値	説明
XTF_TITLESTATE_FASTITERATION_ENABLED	0x0001	このゲームでは、高速反復モードが有効になっています。高速反復モードの詳細については、「アプリケーション管理 (xbapp.exe) (NDA トピック)認可が必須です」および「アプリケーションとファイルの管理 (NDA トピック)認可が必須です」を参照してください。
XTF_TITLESTATE_TITLE_RUNNING	0x0002	ゲームは現在実行中です。
XTF_TITLESTATE_TITLEOS_RUNNING	0x0004	ゲームのゲーム OS は現在実行中です。
XTF_TITLESTATE_TITLENETWORK_READY	0x0008	このゲームでネットワークを使用できます。

pid
型: UINT32*

[out, optional] ゲームが現在実行中の場合は、ゲームのプロセス ID。それ以外の場合は 0。この値が必要ない場合は、nullptr に設定します。

packageFullName
型: PWSTR

[[out, optional] ゲームが現在実行中の場合は、ゲームのパッケージの完全な名前。それ以外の場合は、空の文字列 ("")。この値が必要でない場合またはバッファーの長さが必要な場合は、nullptr に設定します。

packageFullNameLength
型: UINT32*

[out, optional] WCHAR で packageFullName に必要なバッファーの長さ。この値が必要ない場合は、nullptr に設定します。

aumid
型: PWSTR

[out, optional] ゲームが現在実行中の場合は、ゲームの AUMID。それ以外の場合は、空の文字列 ("")。この値が必要ない場合は、nullptr に設定します。

aumidLength
型: UINT32*

[out, optional] WCHAR で aumid に必要なバッファーの長さ。この値が必要ない場合は、nullptr に設定します。

戻り値

型: HRESULT

正常に実行された場合は S_OK を返し、失敗した場合は HRESULT エラーコードを返します。 packageFullName バッファーまたは aumid バッファーが小さすぎる場合には HRESULT_FROM_WIN32(ERROR_MORE_DATA) を返します。

解説

この関数は、現在実行中のゲームの状態に関する情報を返します。これには、タイトルの状態フラグ、プロセス ID、パッケージのフルネーム、アプリケーションユーザーモデル ID (AUMID) が含まれます。パッケージ化の詳細については、「パッケージ化」を参照してください。

packageFullName バッファーおよび aumid バッファーに必要なバッファーの長さを取得するには、以下の手順を実行します。

パラメーター packageFullName および aumid を nullptr に設定します。
パラメーター packageFullNameLength および aumidLength を有効な UINT32 ポインターに設定します。
XtfGetTitleOSState を呼び出す

関数が正常に実行された場合、パラメーター packageFullNameLength と aumidLength には、それぞれ、packageFullName および aumidLength に対して WCHAR で必要なバッファー長が含まれています。

要件

ヘッダー: xtfapi.h

ライブラリ: XtfApi.lib

サポートされているプラットフォーム: Windows (Xbox 本体ツール用)

次の方法で共有

XtfGetTitleOSState

構文

パラメーター

戻り値

解説

要件

関連項目

その他のリソース