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

# 其他 Xtf API (API 內容)

> 其他 Xtf API

# 其他 Xtf API

XBOX Tools Framework (XTF) API 可用於檢查應用程式的可用空間，以及擷取易於使用者理解的錯誤訊息。

## 應用程式函式

| 應用程式函式 | 描述 |
| - | - |
| [XtfPullAuditionApp](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfpullauditionapp-xtfapi-xbox-windows-m.md) | 保留供內部使用。 |
| [XtfPullRegisterApp](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfpullregisterapp-xtfapi-xbox-windows-m.md) | 保留供內部使用。 |
| [XtfPullSupplyMock](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfpullsupplymock-xtfapi-xbox-windows-m.md) | 保留供內部使用。 |
| [XtfPullUnregisterApp](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfpullunregisterapp-xtfapi-xbox-windows-m.md) | 保留供內部使用。 |

## 主機資訊函式

| 主機資訊函式 | 描述 |
| - | - |
| [XtfCloseConsoleInfoList](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md) | 釋放與 XtfGetConsoleInfoList 所傳回之 **XtfConsoleInfo** 物件相關聯的資源。 |
| [XtfGetAvailableSpaceForAppInstallation](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetavailablespaceforappinstallation-xtfconsolecontrol-xbox-microsoft-m.md) | 取得開發主機上指定儲存裝置的可用位元組總數。 |
| [XtfGetConsoleFieldValue](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) | 擷取主機的相關資訊，可以是 Tools IP Address、Console IP Address、AccessKey、Console ID、HostName、Device ID、DevKit Cert type、SystemMajorVersion、SystemMinorVersion、SystemBuildVersion 或 SystemRevisionVersion 其中之一。 |
| [XtfGetConsoleInfoList](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetconsoleinfolist-xtfconsolecontrol-xbox-microsoft-m.md) | 傳回包含主機相關資訊的 `XtfConsoleInfo` 物件。 |
| [XtfGetSavedConsoleAddress](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetsavedconsoleaddress-xtfapi-xbox-windows-m.md) | 取得 XBOX Tools Framework (XTF) 應用程式之預設主機的 Tools IP 位址。 |
| [XtfGetSystemUpTime](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetsystemuptime-xtfapi-xbox-windows-m.md) | 取得 System OS 和 Game OS 已執行的時間量 (以毫秒為單位)。 |
| [XtfWaitForConsoleOSReady](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfwaitforconsoleosready-xtfapi-xbox-windows-m.md) | 等候主機 OS 準備好接收命令後再傳回。 |
| [XtfWaitForConsoleState](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate.md) | 封鎖執行，直到達到指定的主機狀態或發生逾時為止。 |

## 認證函式

| 認證函式 | 描述 |
| - | - |
| [XtfAddCredential](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m.md) | 將認證 (使用者名稱和密碼) 新增至指定的主機，以供「從 PC 執行部署」使用。 |
| [XtfCloseCredentialInfoList](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m.md) | 釋放與 XtfGetCredentialInfoList 所傳回之 XtfNetworkCredentials 物件相關聯的資源。 |
| [XtfGetCredentialInfoCount](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m.md) | 取得 [XtfGetCredentialInfoList](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md) 所傳回之 `XtfNetworkCredentials` 物件中儲存的認證數目。 |
| [XtfGetCredentialInfoList](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md) | 傳回 `XtfNetworkCredentials` 物件，其中包含目前儲存在主機上的認證清單。 |
| [XtfGetCredentialServerName](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcredentialtargetname-xtfapi-xbox-windows-m.md) | 從 XtfGetCredentialInfoList 所傳回之 XtfNetworkCredentials 物件中，取得儲存在某索引處之認證的伺服器名稱部分。 |
| [XtfGetCredentialUserName](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcredentialusername-xtfapi-xbox-windows-m.md) | 從 XtfGetCredentialInfoList 所傳回之 XtfNetworkCredentials 物件中，取得儲存在某索引處之認證的使用者名稱部分。 |
| [XtfRemoveCredential](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfremovecredential-xtfapi-xbox-windows-m.md) | 從指定的主機移除認證。使用 XtfAddCredential 新增認證。 |

## 偵錯函式

| 偵錯函式 | 描述 |
| - | - |
| [XtfCaptureOutputBegin](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md) | 開始擷取偵錯輸出。 |
| [XtfCaptureOutputEnd](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputend-xtfapi-xbox-windows-m.md) | 停止擷取偵錯輸出。 |
| [XtfDebugStringCallback](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfdebugstringcallback-xtfapi-xbox-windows-m.md) | 針對 [XtfCaptureOutputBegin](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md) 所擷取的每個輸出偵錯字串叫用的回呼。 |
| [XtfDebugStringErrorCallback](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfdebugstringerrorcallback-xtfapi-xbox-windows-m.md) | 針對 [XtfCaptureOutputBegin](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md) 所擷取的每個錯誤叫用的回呼。 |
| [XtfGetErrorText](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortext-xtfconsolecontrol-xbox-microsoft-m.md) | 取得指定 `HRESULT` 的易於理解錯誤訊息和動作文字。 |

## 遊戲短片函式

| 遊戲短片函式 | 描述 |
| - | - |
| [XtfCaptureRecordedGameClip](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m.md) | 從目前執行中的遊戲擷取影片短片。 |

## 套件資訊函式

| 套件資訊函式 | 描述 |
| - | - |
| [XtfClosePackageInfo](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfclosepackageinfo-xtfapi-xbox-windows-m.md) | 釋放套件資訊物件。 |
| [XtfGetAumid](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m.md) | 從套件資訊物件取得位於某索引處的應用程式模型使用者識別碼。 |
| [XtfGetCountofAppUserModelIds](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcountofappusermodelids-xtfapi-xbox-windows-m.md) | 從套件資訊物件取得應用程式使用者模型識別碼的數目。 |
| [XtfGetPackageFullName](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m.md) | 從套件資訊物件取得完整套件名稱。 |
| [XtfRegisterAllPackagesOnDrive](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfregisterallpackagesondrive-xtfapi-xbox-windows-m.md) | 註冊部署在指定磁碟機上的所有套件。 |
| [XtfRegisterNetworkSharePackage](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfregisternetworksharepackage-xtfapi-xbox-windows-m.md) | 註冊套件以供「從 PC 執行部署」使用。 |
| [XtfRegisterPackage](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m.md) | 註冊部署至遊戲暫存磁碟機的套件。 |
| [XtfRegisterPackageOnDrive](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfregisterpackageondrive-xtfapi-xbox-windows-m.md) | 註冊部署在指定磁碟機上的套件。 |
| [XtfUnregisterPackage](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfunregisterpackage-xtfapi-xbox-windows-m.md) | 取消註冊部署至遊戲暫存磁碟機的套件。 |

## Title OS 函式

| Title OS 函式 | 描述 |
| - | - |
| [XtfCacheTitleOS](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m.md) | 將 Game OS 新增至 OS 快取。 |
| [XtfGetCachedTitleOSVersions](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md) | 取得快取在主機上之每個 Game OS 的版本資訊。 |
| [XtfGetCachedTitleOSVersionsCallback](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m.md) | 針對 [XtfGetCachedTitleOSVersions](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md) 找到的每個 Game OS 叫用的回呼。 |
| [XtfGetTitleOSFourPartVersion](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m.md) | 取得目前執行中遊戲之 Game OS 的版本資訊。 |
| [XtfGetTitleOSState](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m.md) | 查詢 Title OS、快速反覆運算模式、執行中遊戲、相關聯 PID 和套件資訊的狀態。 |
| [XtfGetTitleProcessMemoryReports](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m.md) | 保留供內部使用。 |
| [XtfRemoveTitleOSFromCache](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcache-xtfapi-xbox-windows-m.md) | 從主機上的快取移除 Game OS。 |
| [XtfRemoveTitleOSFromCacheByVersion](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcachebyversion-xtfapi-xbox-windows-m.md) | 從主機上的快取移除符合指定 [FourPartVersion](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) 的 Game OS。 |
| [XtfShutdownTitleOS](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m.md) | 關閉作用中的遊戲和 Game OS。 |
| [XtfStartTitleOS](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m.md) | 啟動或重新啟動指定的 Game OS。 |
| [XtfStartTitleOSByGameConfig](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbygameconfig-xtfapi-xbox-windows-m.md) | 根據以字串形式儲存在記憶體中的 MicrosoftGame.config 檔案內容，啟動或重新啟動 Game OS。 |
| [XtfStartTitleOSByVersion](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbyversion-xtfapi-xbox-windows-m.md) | 從主機上的快取啟動或重新啟動符合指定 [FourPartVersion](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) 的 Game OS。 |

## 覆疊資料夾函式

| 覆疊資料夾函式 | 描述 |
| - | - |
| [XtfClearAllOverlayFolders](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m.md) | 清除主機上所有已安裝/已註冊套件的覆疊資料夾路徑。 |
| [XtfGetOverlayFolder](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetoverlayfolder-xtfapi-xbox-windows-m.md) | 取得指定套件的覆疊資料夾路徑。 |
| [XtfSetOverlayFolder](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m.md) | 設定指定套件的覆疊資料夾路徑。 |

## 結構

| 結構 | 描述 |
| - | - |
| [FourPartVersion](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) | Game OS 的四部分版本號碼。 |

## 列舉

| 列舉 | 描述 |
| - | - |
| [XtfConsoleCertType 列舉](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/enums/xtfconsolecerttype-xbox-windows-t.md) | 保留供內部使用。 |
| [XtfConsoleFieldId 列舉](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t.md) | 識別要從 [XtfGetConsoleFieldValue](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) 傳回的值。 |
| [XtfConsoleFieldType 列舉](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapi/enums/xtfconsolefieldtype-xbox-windows-t.md) | 識別從 XtfGetConsoleFieldValue 傳回之值的類型。 |


## Related topics

- [XtfApplication (API 內容)](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfapplication/xtfapplication-xbox-microsoft-n.md)
- [XtfInput (API 內容)](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfinput/xtfinput-xbox-microsoft-n.md)
- [XtfFileIO (API 內容)](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtffileio/xtffileio-xbox-microsoft-n.md)
- [XtfUser (API 內容)](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfuser/xtfuser-xbox-windows-n.md)
- [XtfDebugMonitor (API 內容)](https://docs.xbox.com/zh-TW/reference/tools/xtf/xtfdebugmonitor/xtfdebugmonitor-xbox-microsoft-n.md)
