その他の Xtf API
Xbox ツール フレームワーク (XTF) API は、アプリの使用可能な領域を確認し、ユーザーに分かりやすいエラー メッセージを表示するために使用されます。
アプリに関する関数
| アプリに関する関数 | 説明 |
|---|---|
| XtfPullAuditionApp | 内部使用のために予約済みです。 |
| XtfPullRegisterApp | 内部使用のために予約済みです。 |
| XtfPullSupplyMock | 内部使用のために予約済みです。 |
| XtfPullUnregisterApp | 内部使用のために予約済みです。 |
本体情報に関する関数
| 本体情報に関する関数 | 説明 |
|---|---|
| XtfCloseConsoleInfoList | XtfGetConsoleInfoList によって返される XtfConsoleInfo オブジェクトに関連付けられているリソースを解放します。 |
| XtfGetAvailableSpaceForAppInstallation | 開発機本体の指定したストレージ デバイスで使用可能なバイト数の合計を取得します。 |
| XtfGetConsoleFieldValue | 本体に関する情報 (ツールの IP アドレス、本体の IP アドレス、アクセス キー、本体 ID、ホスト名、デバイス ID、開発キットの証明書の種類、システムのメジャーバージョン、システムのマイナーバージョン、システム構築バージョン、またはシステムのリビジョンバージョンのいずれか) を取得します。 |
| XtfGetConsoleInfoList | 本体に関する情報を格納する XtfConsoleInfo オブジェクトを返します。 |
| XtfGetSavedConsoleAddress | Xbox Tools Framework (XTF) アプリの既定の本体のツール IP アドレスを取得します。 |
| XtfGetSystemUpTime | システム OS とゲーム 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 | パッケージの情報オブジェクトから、指定のインデックスのアプリケーション モデル ユーザー ID を取得します。 |
| XtfGetCountofAppUserModelIds | パッケージ情報オブジェクトから、アプリケーション ユーザー モデル ID の数を取得します。 |
| XtfGetPackageFullName | パッケージ情報オブジェクトから完全なパッケージ名を取得します。 |
| XtfRegisterAllPackagesOnDrive | 指定されたドライブに配置されたすべてのパッケージを登録します。 |
| XtfRegisterNetworkSharePackage | PC から実行配置のためのパッケージを登録します。 |
| XtfRegisterPackage | タイトル スクラッチ ドライブに配置されたパッケージを登録します。 |
| XtfRegisterPackageOnDrive | 指定されたドライブに配置されたパッケージを登録します。 |
| XtfUnregisterPackage | タイトル スクラッチ ドライブに配置されたパッケージの登録を解除します。 |
タイトル OS に関する関数
| タイトル OS に関する関数 | 説明 |
|---|---|
| XtfCacheTitleOS | ゲーム OS を OS キャッシュに追加します。 |
| XtfGetCachedTitleOSVersions | 本体にキャッシュされている各ゲーム OS のバージョン情報を取得します。 |
| XtfGetCachedTitleOSVersionsCallback | XtfGetCachedTitleOSVersions によって検出されたゲーム OS ごとに呼び出されるコールバック。 |
| XtfGetTitleOSFourPartVersion | 現在実行中のタイトルのゲーム OS に関するバージョン情報を取得します。 |
| XtfGetTitleOSState | タイトル OS、高速反復モード、実行中のタイトル、関連 PID、およびパッケージ情報の状態をクエリします。 |
| XtfGetTitleProcessMemoryReports | 内部使用のために予約済みです。 |
| XtfRemoveTitleOSFromCache | 本体のキャッシュからゲーム OS を削除します。 |
| XtfRemoveTitleOSFromCacheByVersion | 指定された FourPartVersion と一致するゲーム OS を本体のキャッシュから削除します。 |
| XtfShutdownTitleOS | アクティブなタイトルとゲーム OS をシャットダウンします。 |
| XtfStartTitleOS | 指定されたゲーム OS を起動または再起動します。 |
| XtfStartTitleOSByGameConfig | メモリ内に文字列として保管されている、MicrosoftGame.config ファイルのコンテンツに基づいて、ゲーム OS を起動または再起動します。 |
| XtfStartTitleOSByVersion | 指定された FourPartVersion と一致するゲーム OS を本体のキャッシュから起動または再起動します。 |
オーバーレイ フォルダーに関する関数
| オーバーレイ フォルダーに関する関数 | 説明 |
|---|---|
| XtfClearAllOverlayFolders | 本体にインストールされているか登録されているすべてのパッケージのオーバーレイのフォルダー パスをクリアします。 |
| XtfGetOverlayFolder | 指定されたパッケージのオーバーレイ フォルダーのパスを取得します。 |
| XtfSetOverlayFolder | 指定されたパッケージのオーバーレイ フォルダーのパスを設定します。 |
構造体
| 構造体 | 説明 |
|---|---|
| FourPartVersion | ゲーム OS の 4 つの部分から成るバージョン番号。 |
列挙
| 列挙型 | 説明 |
|---|---|
| XtfConsoleCertType 列挙型 | 内部使用のために予約済みです。 |
| XtfConsoleFieldId 列挙型 | XtfGetConsoleFieldValue から返される値を識別します。 |
| XtfConsoleFieldType 列挙型 | XtfGetConsoleFieldValue から返される値の型を示します。 |