Additional Xtf APIs
XBOX Tools Framework (XTF) API 用于检查应用可用空间并检索用户友好错误消息。应用函数
| 应用函数 | 说明 |
|---|---|
| XtfPullAuditionApp | 保留供内部使用。 |
| XtfPullRegisterApp | 保留供内部使用。 |
| XtfPullSupplyMock | 保留供内部使用。 |
| XtfPullUnregisterApp | 保留供内部使用。 |
主机信息函数
| 主机信息函数 | 说明 |
|---|---|
| XtfCloseConsoleInfoList | 释放与 XtfGetConsoleInfoList 返回的 XtfConsoleInfo 对象关联的资源。 |
| XtfGetAvailableSpaceForAppInstallation | 获取开发主机上指定存储设备的可用总字节数。 |
| XtfGetConsoleFieldValue | 检索主机的信息，包括 Tools IP Address、Console IP Address、AccessKey、Console ID、HostName、Device ID、DevKit Cert type、SystemMajorVersion、SystemMinorVersion、SystemBuildVersion 或 SystemRevisionVersion 之一。 |
| XtfGetConsoleInfoList | 返回包含主机信息的 XtfConsoleInfo 对象。 |
| XtfGetSavedConsoleAddress | 获取 XBOX Tools Framework (XTF) 应用的默认主机的 Tools IP 地址。 |
| XtfGetSystemUpTime | 获取 System OS 和 Game OS 已运行的时间（毫秒）。 |
| XtfWaitForConsoleOSReady | 在返回之前等待主机 OS 准备好接收命令。 |
| XtfWaitForConsoleState | 阻塞执行，直到达到指定的主机状态或发生超时。 |
凭据函数
| 凭据函数 | 说明 |
|---|---|
| XtfAddCredential | 向指定主机添加凭据（用户名和密码），供 Run from PC Deployment 使用。 |
| 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 | 为 Run from PC Deployment 注册一个包。 |
| XtfRegisterPackage | 注册部署到标题临时驱动器上的包。 |
| XtfRegisterPackageOnDrive | 注册部署在指定驱动器上的包。 |
| XtfUnregisterPackage | 注销部署到标题临时驱动器上的包。 |
Title OS 函数
| Title OS 函数 | 说明 |
|---|---|
| XtfCacheTitleOS | 将一个 Game OS 添加到 OS 缓存。 |
| XtfGetCachedTitleOSVersions | 获取主机上缓存的每个 Game OS 的版本信息。 |
| XtfGetCachedTitleOSVersionsCallback | 对 XtfGetCachedTitleOSVersions 找到的每个 Game OS 调用的回调。 |
| XtfGetTitleOSFourPartVersion | 获取当前正在运行的标题的 Game OS 的版本信息。 |
| XtfGetTitleOSState | 查询 Title OS、Fast Iteration Mode、运行中的标题、关联 PID 和包信息的状态。 |
| XtfGetTitleProcessMemoryReports | 保留供内部使用。 |
| XtfRemoveTitleOSFromCache | 从主机上的缓存中移除一个 Game OS。 |
| XtfRemoveTitleOSFromCacheByVersion | 从主机上的缓存中移除与指定 FourPartVersion 匹配的 Game OS。 |
| XtfShutdownTitleOS | 关闭活动标题和 Game OS。 |
| XtfStartTitleOS | 启动或重启指定的 Game OS。 |
| XtfStartTitleOSByGameConfig | 根据以字符串形式存储在内存中的 MicrosoftGame.config 文件的内容，启动或重启 Game OS。 |
| XtfStartTitleOSByVersion | 从主机上的缓存中启动或重启与指定 FourPartVersion 匹配的 Game OS。 |
Overlay Folder 函数
| Overlay Folder 函数 | 说明 |
|---|---|
| XtfClearAllOverlayFolders | 清除主机上所有已安装/已注册包的 Overlay Folder 路径。 |
| XtfGetOverlayFolder | 获取指定包的 Overlay Folder 路径。 |
| XtfSetOverlayFolder | 设置指定包的 Overlay Folder 路径。 |
结构
| 结构 | 说明 |
|---|---|
| FourPartVersion | Game OS 的四部分版本号。 |
枚举
| 枚举 | 说明 |
|---|---|
| XtfConsoleCertType 枚举 | 保留供内部使用。 |
| XtfConsoleFieldId 枚举 | 标识要从 XtfGetConsoleFieldValue 返回的值。 |
| XtfConsoleFieldType 枚举 | 标识 XtfGetConsoleFieldValue 返回值的类型。 |