> ## 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

取得執行中遊戲的相關資訊，包括其狀態、處理序識別碼、套件完整名稱和應用程式使用者模型識別碼 (AUMID)。

<a id="syntaxSection" />

## 語法

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

<a id="parametersSection" />

### 參數

*address*\
類型：PCWSTR

\[in] 主機的位址。

*titleStateFlags*\
類型：UINT32\*

\[out, optional] 旗標的位元 OR 組合，提供有關遊戲的其他資訊。如果不需要此值，請將其設定為 `nullptr`。此參數支援下列旗標：

| 旗標 | 值 | 描述 |
| - | - | - |
| XTF\_TITLESTATE\_FASTITERATION\_ENABLED | 0x0001 | 此遊戲已啟用快速反覆運算模式。如需快速反覆運算模式的詳細資訊，請參閱[應用程式管理 (xbapp.exe) (NDA 主題)](/zh-TW/tools/tools-console/commandlinetools/xbapp) 和[管理應用程式和檔案 (NDA 主題)](/zh-TW/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] 如果遊戲目前正在執行，則為遊戲的處理序識別碼；否則為零。如果不需要此值，請將其設定為 `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" />

### 傳回值

類型：HRESULT

如果成功，則傳回 `S_OK`；否則傳回 HRESULT 錯誤碼。如果 `packageFullName` 或 `aumid` 緩衝區太小，則傳回 `HRESULT_FROM_WIN32(ERROR_MORE_DATA)`。

<a id="remarksSection" />

## 備註

此函式會傳回目前執行中遊戲的狀態資訊，包括遊戲狀態旗標、處理序識別碼、套件完整名稱和應用程式使用者模型識別碼 (AUMID)。如需封裝的詳細資訊，請參閱[封裝](/zh-TW/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" />

## 需求

**標頭：** xtfapi.h

**程式庫：** XtfApi.lib

**支援的平台：** Windows (適用於 XBOX 主機工具)

<a id="seealsoSection" />

## 另請參閱

[XtfGetAumid](/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m)\
[XtfGetPackageFullName](/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m)\
[XTF 傳輸錯誤 (NDA 主題)](/zh-TW/tools/tools-console/commandlinetools/xtf-transport-errors)\
[其他 Xtf API](/zh-TW/reference/tools/xtf/xtfapi/atoc-xtfapi)


## Related topics

- [XtfWaitForConsoleState](/zh-TW/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate.md)
- [XtfGetCachedTitleOSVersions](/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md)
- [XtfGetCachedTitleOSVersionsCallback](/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m.md)
- [XtfGetTitleOSFourPartVersion](/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m.md)
- [XtfGetTitleProcessMemoryReports](/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m.md)