Additional Xtf APIs

The Xbox Tools Framework (XTF) API that is used for checking available space for apps and retrieving user friendly error messages.

Functions

Console info functions

	Name	Description
	XtfCloseConsoleInfoList	Frees resources associated with an XtfConsoleInfo object returned by XtfGetConsoleInfoList.
	XtfGetAvailableSpaceForAppInstallation	Checks the space available for installing apps.
	XtfGetConsoleFieldValue	Retrieves information about a console, one of Tools IP Address, Console IP Address, AccessKey, Console ID, HostName, Device ID, or DevKit Cert type.
	XtfGetConsoleInfoList	Returns an XtfConsoleInfo object that contains information about a console.
	XtfGetSystemUpTime	Get the amount of time in milliseconds that the OS has been running for.
	XtfWaitForConsoleOSReady	Waits until the console OS is ready to receive commands before returning.

Credential functions

	Name	Description
	XtfAddCredential	Add a credential set to a console.
	XtfCloseCredentialInfoList	Free the credential info data.
	XtfGetCredentialCount	Get the count of credentials in the credential info.
	XtfGetCredentialInfoList	Get the list of credentials on a console.
	XtfGetCredentialServerName	Get the target name at the index from the credential info.
	XtfGetCredentialUserName	Get the user name at the index from the credential info.
	XtfRemoveCredential	Remove a credential set from a console.

Debug functions

	Name	Description
	XtfCaptureOutputBegin	Start capturing debug output.
	XtfCaptureOutputEnd	Stop capture debug output.
	XtfGetErrorText	Provides a user friendly error message and trouble shooting guidance for the provided HRESULT.

Game clip functions

	Name	Description
	XtfCaptureRecordedGameClip	Captures a video clip from the currently running game.

Package info functions

	Name	Description
	XtfClosePackageInfo	Frees a package information object.
	XtfGetAumid	Gets the application model user ID at an index from a package information object.
	XtfGetCountofAppUserModelIds	Gets the count of application user model IDs from a package information object.
	XtfRegisterPackage	Registers a package deployed to the title scratch drive.
	XtfUnregisterPackage	Unregisters a package deployed to the title scratch drive.

Title OS functions

	Name	Description
	XtfGetTitleOSState	Gets the state of the Title OS, Fast Iteration Mode, running Title, associate PID, and Package information.

Overlay Folder functions

	Name	Description
	XtfGetOverlayFolder	Gets the overlay folder path for a package.
	XtfSetOverlayFolder	Sets the overlay folder path for a package.
	XtfClearAllOverlayFolders	Clears all overlay folders set on the console.

Enumerations

	Name	Description
	XtfConsoleCertType	Identifies the Devkit Certificate type installed on this Devkit.
	XtfConsoleFieldId	Identifies the value to return from XtfGetConsoleFieldValue.
	XtfConsoleFieldType	Identifies the type of the value returned from XtfGetConsoleFieldValue.