其他 Xtf API
Xbox Tools Framework (XTF) API 用于检查应用的可用空间，以及检索用户友好型错误消息。
应用函数
| 应用函数 | 说明 |
|---|---|
| XtfPullAuditionApp | 保留供内部使用。 |
| XtfPullRegisterApp | 保留供内部使用。 |
| XtfPullSupplyMock | 保留供内部使用。 |
| XtfPullUnregisterApp | 保留供内部使用。 |
主机信息函数
| 主机信息函数 | 说明 |
|---|---|
| XtfCloseConsoleInfoList | 释放与 XtfGetConsoleInfoList 返回的 XtfConsoleInfo 对象关联的资源。 |
| XtfGetAvailableSpaceForAppInstallation | 获取开发主机的指定存储设备上的总可用字节数。 |
| XtfGetConsoleFieldValue | 检索有关主机的信息，可以是以下项之一：工具 IP 地址、主机 IP 地址、AccessKey、主机 ID、HostName、设备 ID、开发工具包证书类型、SystemMajorVersion、SystemMinorVersion、SystemBuildVersion 或 SystemRevisionVersion。 |
| XtfGetConsoleInfoList | 返回包含关于主机信息的 XtfConsoleInfo 对象。 |
| XtfGetSavedConsoleAddress | 获取 Xbox 工具框架 (XTF) 应用的默认主机的工具 IP 地址。 |
| XtfGetSystemUpTime | 获取系统操作系统和游戏操作系统已经运行的时间量（以毫秒为单位）。 |
| XtfWaitForConsoleOSReady | 在返回前一直等待，直到主机操作系统准备好接收命令。 |
| XtfWaitForConsoleState | 在达到指定的主机状态或者发生超时前一直执行阻止。 |
凭据函数
| 凭据函数 | 说明 |
|---|---|
| XtfAddCredential | 向给定的主机添加凭据（用户名和密码）以用于“从电脑部署运行”。 |
| XtfCloseCredentialInfoList | 释放与 XtfGetCredentialInfoList 返回的 XtfNetworkCredentials 对象关联的资源。 |
| XtfGetCredentialInfoCount | 获取 XtfGetCredentialInfoList 返回的 XtfNetworkCredentials 对象中存储的凭据计数。 |
| XtfGetCredentialInfoList | 返回 XtfNetworkCredentials 对象，该对象包含主机上当前存储的凭据的列表。 |
| XtfGetCredentialServerName | 获取 XtfGetCredentialInfoList 返回的 XtfNetworkCredentials 对象中某索引处存储的凭据的服务器名称部分。 |
| XtfGetCredentialUserName | 获取 XtfGetCredentialInfoList 返回的 XtfNetworkCredentials 对象中某索引处存储的凭据的用户名部分。 |
| XtfRemoveCredential | 从给定的主机删除凭据。 使用 XtfAddCredential 添加凭据。 |
调试函数
| 调试函数 | 说明 |
|---|---|
| XtfCaptureOutputBegin | 开始捕获调试输出。 |
| XtfCaptureOutputEnd | 停止捕获调试输出。 |
| XtfDebugStringCallback | 为 XtfCaptureOutputBegin 捕获的每个输出调试字符串调用的回调。 |
| XtfDebugStringErrorCallback | 为 XtfCaptureOutputBegin 捕获的每个错误调用的回调。 |
| XtfGetErrorText | 获取指定的 HRESULT 的用户友好错误消息和操作文本。 |
游戏剪辑函数
| 游戏剪辑函数 | 说明 |
|---|---|
| XtfCaptureRecordedGameClip | 从当前运行的游戏捕获视频剪辑。 |
包信息函数
| 包信息函数 | 说明 |
|---|---|
| XtfClosePackageInfo | 释放包信息对象。 |
| XtfGetAumid | 从包信息对象索引处获取应用程序模型用户 ID。 |
| XtfGetCountofAppUserModelIds | 从包信息对象获取应用程序用户模型 ID 的计数。 |
| XtfGetPackageFullName | 从包信息对象中获取完整包名称。 |
| XtfRegisterAllPackagesOnDrive | 在指定的驱动器上注册所有部署的包。 |
| XtfRegisterNetworkSharePackage | 为“从电脑部署运行”注册包。 |
| XtfRegisterPackage | 注册部署到游戏暂存驱动器的包。 |
| XtfRegisterPackageOnDrive | 注册在指定驱动器上部署的包。 |
| XtfUnregisterPackage | 注销部署到游戏暂存驱动器的包。 |
游戏操作系统函数
| 游戏操作系统函数 | 说明 |
|---|---|
| XtfCacheTitleOS | 向 OS 缓存添加游戏 OS。 |
| XtfGetCachedTitleOSVersions | 获取主机上缓存的每个游戏 OS 的版本信息。 |
| XtfGetCachedTitleOSVersionsCallback | 为 XtfGetCachedTitleOSVersions 找到的每个游戏 OS 调用的回调。 |
| XtfGetTitleOSFourPartVersion | 获取有关当前运行的游戏的游戏 OS 的版本信息。 |
| XtfGetTitleOSState | 查询游戏操作系统的状态、快速迭代模式、运行的游戏、关联 PID 以及包信息。 |
| XtfGetTitleProcessMemoryReports | 保留供内部使用。 |
| XtfRemoveTitleOSFromCache | 从主机上的缓存删除游戏 OS。 |
| XtfRemoveTitleOSFromCacheByVersion | 从主机上的缓存中删除与指定 FourPartVersion 匹配的游戏 OS。 |
| XtfShutdownTitleOS | 关闭处于活动状态的游戏和游戏 OS。 |
| XtfStartTitleOS | 启动或重启指定的游戏 OS。 |
| XtfStartTitleOSByGameConfig | 根据以字符串形式存储在内存中的 MicrosoftGame.config 文件的内容，启动或重新启动游戏操作系统。 |
| XtfStartTitleOSByVersion | 从主机上的缓存中启动或重启与指定 FourPartVersion 匹配的游戏 OS。 |
覆盖文件夹函数
| 覆盖文件夹函数 | 描述 |
|---|---|
| XtfClearAllOverlayFolders | 清除在主机上安装/注册的所有包的覆盖文件夹路径。 |
| XtfGetOverlayFolder | 获取指定包的覆盖文件夹路径。 |
| XtfSetOverlayFolder | 设置指定包的覆盖文件夹路径。 |
结构
| 结构 | 说明 |
|---|---|
| FourPartVersion | 由四部分组成的游戏 OS 版本号。 |
枚举
| 枚举 | 说明 |
|---|---|
| XtfConsoleCertType 枚举 | 保留供内部使用。 |
| XtfConsoleFieldId 枚举 | 标识要从 XtfGetConsoleFieldValue 返回的值。 |
| XtfConsoleFieldType 枚举 | 标识从 XtfGetConsoleFieldValue 返回的值的类型。 |