其他 Xtf API
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 | 將認證 (使用者名稱和密碼) 新增至指定的主機,以供「從 PC 執行部署」使用。 |
| 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 | 從套件資訊物件取得位於某索引處的應用程式模型使用者識別碼。 |
| XtfGetCountofAppUserModelIds | 從套件資訊物件取得應用程式使用者模型識別碼的數目。 |
| XtfGetPackageFullName | 從套件資訊物件取得完整套件名稱。 |
| XtfRegisterAllPackagesOnDrive | 註冊部署在指定磁碟機上的所有套件。 |
| XtfRegisterNetworkSharePackage | 註冊套件以供「從 PC 執行部署」使用。 |
| XtfRegisterPackage | 註冊部署至遊戲暫存磁碟機的套件。 |
| XtfRegisterPackageOnDrive | 註冊部署在指定磁碟機上的套件。 |
| XtfUnregisterPackage | 取消註冊部署至遊戲暫存磁碟機的套件。 |
Title OS 函式
| Title OS 函式 | 描述 |
|---|---|
| XtfCacheTitleOS | 將 Game OS 新增至 OS 快取。 |
| XtfGetCachedTitleOSVersions | 取得快取在主機上之每個 Game OS 的版本資訊。 |
| XtfGetCachedTitleOSVersionsCallback | 針對 XtfGetCachedTitleOSVersions 找到的每個 Game OS 叫用的回呼。 |
| XtfGetTitleOSFourPartVersion | 取得目前執行中遊戲之 Game OS 的版本資訊。 |
| XtfGetTitleOSState | 查詢 Title OS、快速反覆運算模式、執行中遊戲、相關聯 PID 和套件資訊的狀態。 |
| XtfGetTitleProcessMemoryReports | 保留供內部使用。 |
| XtfRemoveTitleOSFromCache | 從主機上的快取移除 Game OS。 |
| XtfRemoveTitleOSFromCacheByVersion | 從主機上的快取移除符合指定 FourPartVersion 的 Game OS。 |
| XtfShutdownTitleOS | 關閉作用中的遊戲和 Game OS。 |
| XtfStartTitleOS | 啟動或重新啟動指定的 Game OS。 |
| XtfStartTitleOSByGameConfig | 根據以字串形式儲存在記憶體中的 MicrosoftGame.config 檔案內容,啟動或重新啟動 Game OS。 |
| XtfStartTitleOSByVersion | 從主機上的快取啟動或重新啟動符合指定 FourPartVersion 的 Game OS。 |
覆疊資料夾函式
| 覆疊資料夾函式 | 描述 |
|---|---|
| XtfClearAllOverlayFolders | 清除主機上所有已安裝/已註冊套件的覆疊資料夾路徑。 |
| XtfGetOverlayFolder | 取得指定套件的覆疊資料夾路徑。 |
| XtfSetOverlayFolder | 設定指定套件的覆疊資料夾路徑。 |
結構
| 結構 | 描述 |
|---|---|
| FourPartVersion | Game OS 的四部分版本號碼。 |
列舉
| 列舉 | 描述 |
|---|---|
| XtfConsoleCertType 列舉 | 保留供內部使用。 |
| XtfConsoleFieldId 列舉 | 識別要從 XtfGetConsoleFieldValue 傳回的值。 |
| XtfConsoleFieldType 列舉 | 識別從 XtfGetConsoleFieldValue 傳回之值的類型。 |
