> ## 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 内容） > Additional Xtf APIs # Additional Xtf APIs XBOX Tools Framework (XTF) API 用于检查应用可用空间并检索用户友好错误消息。 ## 应用函数 | 应用函数 | 说明 | | - | - | | [XtfPullAuditionApp](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfpullauditionapp-xtfapi-xbox-windows-m.md) | 保留供内部使用。 | | [XtfPullRegisterApp](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfpullregisterapp-xtfapi-xbox-windows-m.md) | 保留供内部使用。 | | [XtfPullSupplyMock](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfpullsupplymock-xtfapi-xbox-windows-m.md) | 保留供内部使用。 | | [XtfPullUnregisterApp](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfpullunregisterapp-xtfapi-xbox-windows-m.md) | 保留供内部使用。 | ## 主机信息函数 | 主机信息函数 | 说明 | | - | - | | [XtfCloseConsoleInfoList](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md) | 释放与 XtfGetConsoleInfoList 返回的 **XtfConsoleInfo** 对象关联的资源。 | | [XtfGetAvailableSpaceForAppInstallation](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetavailablespaceforappinstallation-xtfconsolecontrol-xbox-microsoft-m.md) | 获取开发主机上指定存储设备的可用总字节数。 | | [XtfGetConsoleFieldValue](https://docs.xbox.com/zh-CN/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-CN/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetconsoleinfolist-xtfconsolecontrol-xbox-microsoft-m.md) | 返回包含主机信息的 `XtfConsoleInfo` 对象。 | | [XtfGetSavedConsoleAddress](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetsavedconsoleaddress-xtfapi-xbox-windows-m.md) | 获取 XBOX Tools Framework (XTF) 应用的默认主机的 Tools IP 地址。 | | [XtfGetSystemUpTime](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetsystemuptime-xtfapi-xbox-windows-m.md) | 获取 System OS 和 Game OS 已运行的时间（毫秒）。 | | [XtfWaitForConsoleOSReady](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfwaitforconsoleosready-xtfapi-xbox-windows-m.md) | 在返回之前等待主机 OS 准备好接收命令。 | | [XtfWaitForConsoleState](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate.md) | 阻塞执行，直到达到指定的主机状态或发生超时。 | ## 凭据函数 | 凭据函数 | 说明 | | - | - | | [XtfAddCredential](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m.md) | 向指定主机添加凭据（用户名和密码），供 Run from PC Deployment 使用。 | | [XtfCloseCredentialInfoList](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m.md) | 释放与 XtfGetCredentialInfoList 返回的 XtfNetworkCredentials 对象关联的资源。 | | [XtfGetCredentialInfoCount](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m.md) | 获取 [XtfGetCredentialInfoList](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md) 返回的 `XtfNetworkCredentials` 对象中存储的凭据数量。 | | [XtfGetCredentialInfoList](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md) | 返回包含当前存储在主机上的凭据列表的 `XtfNetworkCredentials` 对象。 | | [XtfGetCredentialServerName](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcredentialtargetname-xtfapi-xbox-windows-m.md) | 获取由 XtfGetCredentialInfoList 返回的 XtfNetworkCredentials 对象中指定索引处凭据的服务器名部分。 | | [XtfGetCredentialUserName](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcredentialusername-xtfapi-xbox-windows-m.md) | 获取由 XtfGetCredentialInfoList 返回的 XtfNetworkCredentials 对象中指定索引处凭据的用户名部分。 | | [XtfRemoveCredential](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfremovecredential-xtfapi-xbox-windows-m.md) | 从指定主机移除凭据。使用 XtfAddCredential 添加凭据。 | ## 调试函数 | 调试函数 | 说明 | | - | - | | [XtfCaptureOutputBegin](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md) | 开始捕获调试输出。 | | [XtfCaptureOutputEnd](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputend-xtfapi-xbox-windows-m.md) | 停止捕获调试输出。 | | [XtfDebugStringCallback](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfdebugstringcallback-xtfapi-xbox-windows-m.md) | 对由 [XtfCaptureOutputBegin](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md) 捕获的每个输出调试字符串调用的回调。 | | [XtfDebugStringErrorCallback](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfdebugstringerrorcallback-xtfapi-xbox-windows-m.md) | 对由 [XtfCaptureOutputBegin](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md) 捕获的每个错误调用的回调。 | | [XtfGetErrorText](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortext-xtfconsolecontrol-xbox-microsoft-m.md) | 获取指定 `HRESULT` 的用户友好错误消息和操作文本。 | ## 游戏剪辑函数 | 游戏剪辑函数 | 说明 | | - | - | | [XtfCaptureRecordedGameClip](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m.md) | 从当前运行的游戏中捕获视频剪辑。 | ## 包信息函数 | 包信息函数 | 说明 | | - | - | | [XtfClosePackageInfo](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfclosepackageinfo-xtfapi-xbox-windows-m.md) | 释放一个包信息对象。 | | [XtfGetAumid](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m.md) | 从包信息对象中获取指定索引处的应用程序模型用户 ID。 | | [XtfGetCountofAppUserModelIds](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcountofappusermodelids-xtfapi-xbox-windows-m.md) | 从包信息对象中获取应用程序用户模型 ID 的数量。 | | [XtfGetPackageFullName](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m.md) | 从包信息对象中获取包的完整名称。 | | [XtfRegisterAllPackagesOnDrive](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfregisterallpackagesondrive-xtfapi-xbox-windows-m.md) | 注册部署在指定驱动器上的所有包。 | | [XtfRegisterNetworkSharePackage](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfregisternetworksharepackage-xtfapi-xbox-windows-m.md) | 为 Run from PC Deployment 注册一个包。 | | [XtfRegisterPackage](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m.md) | 注册部署到标题临时驱动器上的包。 | | [XtfRegisterPackageOnDrive](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfregisterpackageondrive-xtfapi-xbox-windows-m.md) | 注册部署在指定驱动器上的包。 | | [XtfUnregisterPackage](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfunregisterpackage-xtfapi-xbox-windows-m.md) | 注销部署到标题临时驱动器上的包。 | ## Title OS 函数 | Title OS 函数 | 说明 | | - | - | | [XtfCacheTitleOS](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m.md) | 将一个 Game OS 添加到 OS 缓存。 | | [XtfGetCachedTitleOSVersions](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md) | 获取主机上缓存的每个 Game OS 的版本信息。 | | [XtfGetCachedTitleOSVersionsCallback](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m.md) | 对 [XtfGetCachedTitleOSVersions](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md) 找到的每个 Game OS 调用的回调。 | | [XtfGetTitleOSFourPartVersion](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m.md) | 获取当前正在运行的标题的 Game OS 的版本信息。 | | [XtfGetTitleOSState](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m.md) | 查询 Title OS、Fast Iteration Mode、运行中的标题、关联 PID 和包信息的状态。 | | [XtfGetTitleProcessMemoryReports](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m.md) | 保留供内部使用。 | | [XtfRemoveTitleOSFromCache](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcache-xtfapi-xbox-windows-m.md) | 从主机上的缓存中移除一个 Game OS。 | | [XtfRemoveTitleOSFromCacheByVersion](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcachebyversion-xtfapi-xbox-windows-m.md) | 从主机上的缓存中移除与指定 [FourPartVersion](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) 匹配的 Game OS。 | | [XtfShutdownTitleOS](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m.md) | 关闭活动标题和 Game OS。 | | [XtfStartTitleOS](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m.md) | 启动或重启指定的 Game OS。 | | [XtfStartTitleOSByGameConfig](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbygameconfig-xtfapi-xbox-windows-m.md) | 根据以字符串形式存储在内存中的 MicrosoftGame.config 文件的内容，启动或重启 Game OS。 | | [XtfStartTitleOSByVersion](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbyversion-xtfapi-xbox-windows-m.md) | 从主机上的缓存中启动或重启与指定 [FourPartVersion](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) 匹配的 Game OS。 | ## Overlay Folder 函数 | Overlay Folder 函数 | 说明 | | - | - | | [XtfClearAllOverlayFolders](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m.md) | 清除主机上所有已安装/已注册包的 Overlay Folder 路径。 | | [XtfGetOverlayFolder](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetoverlayfolder-xtfapi-xbox-windows-m.md) | 获取指定包的 Overlay Folder 路径。 | | [XtfSetOverlayFolder](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m.md) | 设置指定包的 Overlay Folder 路径。 | ## 结构 | 结构 | 说明 | | - | - | | [FourPartVersion](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) | Game OS 的四部分版本号。 | ## 枚举 | 枚举 | 说明 | | - | - | | [XtfConsoleCertType 枚举](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/enums/xtfconsolecerttype-xbox-windows-t.md) | 保留供内部使用。 | | [XtfConsoleFieldId 枚举](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t.md) | 标识要从 [XtfGetConsoleFieldValue](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) 返回的值。 | | [XtfConsoleFieldType 枚举](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapi/enums/xtfconsolefieldtype-xbox-windows-t.md) | 标识 XtfGetConsoleFieldValue 返回值的类型。 | ## Related topics - [XtfFileIO（API 内容）](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtffileio/xtffileio-xbox-microsoft-n.md) - [XtfApplication（API 内容）](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfapplication/xtfapplication-xbox-microsoft-n.md) - [XtfInput（API 内容）](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfinput/xtfinput-xbox-microsoft-n.md) - [XtfUser（API 内容）](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfuser/xtfuser-xbox-windows-n.md) - [XtfConsoleControl（API 内容）](https://docs.xbox.com/zh-CN/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members.md)