> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XtfGetTitleOSState

> XtfGetTitleOSState

# XtfGetTitleOSState

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

<a id="syntaxSection" />

## Syntax

```cpp theme={null}
HRESULT XtfGetTitleOSState(
        PCWSTR address,
        UINT32* titleStateFlags,
        UINT32* pid,
        PWSTR packageFullName,
        UINT32* packageFullNameLength,
        PWSTR aumid,
        UINT32* aumidLength)
```

<a id="parametersSection" />

### Parameters

*address*\
型: PCWSTR

\[in] コンソールのアドレスです。

*titleStateFlags*\
型: UINT32\*

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

| Flag                                    | Value  | Description                                                                                                                                                                                                                                                                                 |
| --------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| XTF\_TITLESTATE\_FASTITERATION\_ENABLED | 0x0001 | このゲームで Fast Iteration Mode が有効になっています。Fast Iteration Mode の詳細については、[Application Management (xbapp.exe) (NDA topic)](/tools/tools-console/commandlinetools/xbapp) および [Managing applications and files (NDA topic)](/tools/tools-console/xbom/manager-tool-managing-applications) を参照してください。 |
| XTF\_TITLESTATE\_TITLE\_RUNNING         | 0x0002 | ゲームが現在実行中です。                                                                                                                                                                                                                                                                                |
| XTF\_TITLESTATE\_TITLEOS\_RUNNING       | 0x0004 | ゲームの Game OS が現在実行中です。                                                                                                                                                                                                                                                                      |
| XTF\_TITLESTATE\_TITLENETWORK\_READY    | 0x0008 | ゲームのネットワークが利用可能です。                                                                                                                                                                                                                                                                          |

*pid*\
型: UINT32\*

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

*packageFullName*\
型: PWSTR

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

*packageFullNameLength*\
型: UINT32\*

\[out, optional] *packageFullName* に必要なバッファーの長さ (WCHAR 単位) です。この値が不要な場合は `nullptr` に設定します。

*aumid*\
型: PWSTR

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

*aumidLength*\
型: UINT32\*

\[out, optional] *aumid* に必要なバッファーの長さ (WCHAR 単位) です。この値が不要な場合は `nullptr` に設定します。

<a id="retvalSection" />

### Return value

型: HRESULT

成功した場合は `S_OK` を返します。それ以外の場合は、HRESULT エラー コードを返します。`packageFullName` または `aumid` のバッファーが小さすぎる場合は `HRESULT_FROM_WIN32(ERROR_MORE_DATA)` を返します。

<a id="remarksSection" />

## Remarks

この関数は、現在実行中のゲームの状態に関する情報 (タイトル状態フラグ、プロセス ID、パッケージのフル ネーム、アプリケーション ユーザー モデル ID (AUMID) など) を返します。パッケージ化の詳細については、[Packaging](/build/core-features/common/packaging/gc-packaging-toc) を参照してください。

`packageFullName` と `aumid` のバッファーに必要な長さを取得するには、次の手順を実行します。

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

関数が正常に実行されると、`packageFullNameLength` および `aumidLength` パラメーターには、それぞれ `packageFullName` および `aumidLength` に必要なバッファーの長さが WCHAR 単位で格納されます。

<a id="requirementsSection" />

## Requirements

**ヘッダー:** xtfapi.h

**ライブラリ:** XtfApi.lib

**サポートされているプラットフォーム:** Windows (XBOX コンソール ツール用)

<a id="seealsoSection" />

## See also

[XtfGetAumid](/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m)\
[XtfGetPackageFullName](/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m)\
[XTF Transport Errors (NDA topic)](/tools/tools-console/commandlinetools/xtf-transport-errors)\
[Additional Xtf APIs](/reference/tools/xtf/xtfapi/atoc-xtfapi)


## Related topics

- [XtfGetCachedTitleOSVersions](/ja-jp/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md)
- [XtfGetCachedTitleOSVersionsCallback](/ja-jp/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m.md)
- [XtfGetTitleOSFourPartVersion](/ja-jp/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m.md)
- [XtfGetTitleProcessMemoryReports](/ja-jp/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m.md)
- [XtfStartTitleOS](/ja-jp/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m.md)