Additional Xtf APIs
XBOX Tools Framework (XTF) API は、アプリの利用可能な領域の確認や、ユーザーにわかりやすいエラー メッセージの取得に使用されます。App functions
| App function | Description |
|---|---|
| XtfPullAuditionApp | 内部使用のために予約されています。 |
| XtfPullRegisterApp | 内部使用のために予約されています。 |
| XtfPullSupplyMock | 内部使用のために予約されています。 |
| XtfPullUnregisterApp | 内部使用のために予約されています。 |
Console info functions
| Console info function | Description |
|---|---|
| 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 | 指定されたコンソールの状態に到達するか、タイムアウトが発生するまで実行をブロックします。 |
Credential functions
| Credential function | Description |
|---|---|
| XtfAddCredential | Run from PC Deployment で使用するために、指定されたコンソールへ資格情報 (ユーザー名とパスワード) を追加します。 |
| XtfCloseCredentialInfoList | XtfGetCredentialInfoList によって返された XtfNetworkCredentials オブジェクトに関連付けられたリソースを解放します。 |
| XtfGetCredentialInfoCount | XtfGetCredentialInfoList によって返された XtfNetworkCredentials オブジェクトに格納されている資格情報の数を取得します。 |
| XtfGetCredentialInfoList | 現在コンソールに保存されている資格情報の一覧を含む XtfNetworkCredentials オブジェクトを返します。 |
| XtfGetCredentialServerName | XtfGetCredentialInfoList によって返された XtfNetworkCredentials オブジェクトの、あるインデックスに保存されている資格情報のサーバー名部分を取得します。 |
| XtfGetCredentialUserName | XtfGetCredentialInfoList によって返された XtfNetworkCredentials オブジェクトの、あるインデックスに保存されている資格情報のユーザー名部分を取得します。 |
| XtfRemoveCredential | 指定されたコンソールから資格情報を削除します。資格情報の追加には XtfAddCredential を使用してください。 |
Debug functions
| Debug function | Description |
|---|---|
| XtfCaptureOutputBegin | デバッグ出力のキャプチャを開始します。 |
| XtfCaptureOutputEnd | デバッグ出力のキャプチャを停止します。 |
| XtfDebugStringCallback | XtfCaptureOutputBegin によってキャプチャされた出力デバッグ文字列ごとに呼び出されるコールバックです。 |
| XtfDebugStringErrorCallback | XtfCaptureOutputBegin によってキャプチャされたエラーごとに呼び出されるコールバックです。 |
| XtfGetErrorText | 指定された HRESULT について、ユーザーにわかりやすいエラー メッセージとアクション テキストを取得します。 |
Game clip functions
| Game clip function | Description |
|---|---|
| XtfCaptureRecordedGameClip | 現在実行中のゲームからビデオ クリップをキャプチャします。 |
Package info functions
| Package info function | Description |
|---|---|
| XtfClosePackageInfo | パッケージ情報オブジェクトを解放します。 |
| XtfGetAumid | パッケージ情報オブジェクトから、指定されたインデックスのアプリケーション モデル ユーザー ID を取得します。 |
| XtfGetCountofAppUserModelIds | パッケージ情報オブジェクトから、アプリケーション ユーザー モデル ID の数を取得します。 |
| XtfGetPackageFullName | パッケージ情報オブジェクトからパッケージのフル ネームを取得します。 |
| XtfRegisterAllPackagesOnDrive | 指定されたドライブにデプロイされているすべてのパッケージを登録します。 |
| XtfRegisterNetworkSharePackage | Run from PC Deployment 用にパッケージを登録します。 |
| XtfRegisterPackage | タイトル スクラッチ ドライブにデプロイされたパッケージを登録します。 |
| XtfRegisterPackageOnDrive | 指定されたドライブにデプロイされたパッケージを登録します。 |
| XtfUnregisterPackage | タイトル スクラッチ ドライブにデプロイされたパッケージの登録を解除します。 |
Title OS functions
| Title OS function | Description |
|---|---|
| XtfCacheTitleOS | OS キャッシュに Game 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 functions
| Overlay Folder function | Description |
|---|---|
| XtfClearAllOverlayFolders | コンソールにインストール/登録されているすべてのパッケージのオーバーレイ フォルダー パスをクリアします。 |
| XtfGetOverlayFolder | 指定されたパッケージのオーバーレイ フォルダー パスを取得します。 |
| XtfSetOverlayFolder | 指定されたパッケージのオーバーレイ フォルダー パスを設定します。 |
Structures
| Structure | Description |
|---|---|
| FourPartVersion | Game OS の 4 部構成のバージョン番号です。 |
Enumerations
| Enumeration | Description |
|---|---|
| XtfConsoleCertType Enumeration | 内部使用のために予約されています。 |
| XtfConsoleFieldId Enumeration | XtfGetConsoleFieldValue から返される値を識別します。 |
| XtfConsoleFieldType Enumeration | XtfGetConsoleFieldValue から返される値の型を識別します。 |