> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # Additional Xtf APIs > Additional Xtf APIs # Additional Xtf APIs The XBOX Tools Framework (XTF) API is used for checking available space for apps and retrieving user friendly error messages. ## App functions | App function | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------- | | [XtfPullAuditionApp](/reference/tools/xtf/xtfapi/functions/xtfpullauditionapp-xtfapi-xbox-windows-m) | Reserved for internal use. | | [XtfPullRegisterApp](/reference/tools/xtf/xtfapi/functions/xtfpullregisterapp-xtfapi-xbox-windows-m) | Reserved for internal use. | | [XtfPullSupplyMock](/reference/tools/xtf/xtfapi/functions/xtfpullsupplymock-xtfapi-xbox-windows-m) | Reserved for internal use. | | [XtfPullUnregisterApp](/reference/tools/xtf/xtfapi/functions/xtfpullunregisterapp-xtfapi-xbox-windows-m) | Reserved for internal use. | ## Console info functions | Console info function | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [XtfCloseConsoleInfoList](/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m) | Frees resources associated with an **XtfConsoleInfo** object returned by XtfGetConsoleInfoList. | | [XtfGetAvailableSpaceForAppInstallation](/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetavailablespaceforappinstallation-xtfconsolecontrol-xbox-microsoft-m) | Gets the total number of bytes available on the specified storage device of a development console. | | [XtfGetConsoleFieldValue](/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m) | Retrieves information about a console, one of Tools IP Address, Console IP Address, AccessKey, Console ID, HostName, Device ID, DevKit Cert type, SystemMajorVersion, SystemMinorVersion, SystemBuildVersion, or SystemRevisionVersion. | | [XtfGetConsoleInfoList](/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetconsoleinfolist-xtfconsolecontrol-xbox-microsoft-m) | Returns an `XtfConsoleInfo` object that contains information about a console. | | [XtfGetSavedConsoleAddress](/reference/tools/xtf/xtfapi/functions/xtfgetsavedconsoleaddress-xtfapi-xbox-windows-m) | Gets the Tools IP address of the default console for XBOX Tools Framework (XTF) apps. | | [XtfGetSystemUpTime](/reference/tools/xtf/xtfapi/functions/xtfgetsystemuptime-xtfapi-xbox-windows-m) | Gets the amount of time in milliseconds that the System OS and Game OS have been running. | | [XtfWaitForConsoleOSReady](/reference/tools/xtf/xtfapi/functions/xtfwaitforconsoleosready-xtfapi-xbox-windows-m) | Waits until the console OS is ready to receive commands before returning. | | [XtfWaitForConsoleState](/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate) | Blocks execution until either the specified console states are reached or a timeout occurs. | ## Credential functions | Credential function | Description | | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [XtfAddCredential](/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m) | Adds credentials (user name and password) to the given console for use by Run from PC Deployment. | | [XtfCloseCredentialInfoList](/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m) | Frees resources associated with an XtfNetworkCredentials object returned by XtfGetCredentialInfoList. | | [XtfGetCredentialInfoCount](/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m) | Gets the count of credentials stored in an `XtfNetworkCredentials` object returned by [XtfGetCredentialInfoList](/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m). | | [XtfGetCredentialInfoList](/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m) | Returns an `XtfNetworkCredentials` object that contains the list of credentials currently stored on the console. | | [XtfGetCredentialServerName](/reference/tools/xtf/xtfapi/functions/xtfgetcredentialtargetname-xtfapi-xbox-windows-m) | Gets the server name part of the credentials stored at an index in an XtfNetworkCredentials object returned by XtfGetCredentialInfoList. | | [XtfGetCredentialUserName](/reference/tools/xtf/xtfapi/functions/xtfgetcredentialusername-xtfapi-xbox-windows-m) | Gets the user name part of the credentials stored at an index in an XtfNetworkCredentials object returned by XtfGetCredentialInfoList. | | [XtfRemoveCredential](/reference/tools/xtf/xtfapi/functions/xtfremovecredential-xtfapi-xbox-windows-m) | Removes credentials from the given console. Use XtfAddCredential add credentials. | ## Debug functions | Debug function | Description | | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [XtfCaptureOutputBegin](/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m) | Starts capture of debug output. | | [XtfCaptureOutputEnd](/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputend-xtfapi-xbox-windows-m) | Stop capture debug output. | | [XtfDebugStringCallback](/reference/tools/xtf/xtfapi/functions/xtfdebugstringcallback-xtfapi-xbox-windows-m) | Callback invoked for each output debug string captured by [XtfCaptureOutputBegin](/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m). | | [XtfDebugStringErrorCallback](/reference/tools/xtf/xtfapi/functions/xtfdebugstringerrorcallback-xtfapi-xbox-windows-m) | Callback invoked for each error captured by [XtfCaptureOutputBegin](/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m). | | [XtfGetErrorText](/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortext-xtfconsolecontrol-xbox-microsoft-m) | Gets a user-friendly error message and action text for the specified `HRESULT`. | ## Game clip functions | Game clip function | Description | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | [XtfCaptureRecordedGameClip](/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m) | Captures a video clip from the currently running game. | ## Package info functions | Package info function | Description | | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | [XtfClosePackageInfo](/reference/tools/xtf/xtfapi/functions/xtfclosepackageinfo-xtfapi-xbox-windows-m) | Frees a package information object. | | [XtfGetAumid](/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m) | Gets the application model user ID at an index from a package information object. | | [XtfGetCountofAppUserModelIds](/reference/tools/xtf/xtfapi/functions/xtfgetcountofappusermodelids-xtfapi-xbox-windows-m) | Gets the count of application user model IDs from a package information object. | | [XtfGetPackageFullName](/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m) | Get the full package name from a package information object. | | [XtfRegisterAllPackagesOnDrive](/reference/tools/xtf/xtfapi/functions/xtfregisterallpackagesondrive-xtfapi-xbox-windows-m) | Register all packages deployed on the specified drive. | | [XtfRegisterNetworkSharePackage](/reference/tools/xtf/xtfapi/functions/xtfregisternetworksharepackage-xtfapi-xbox-windows-m) | Registers a package for Run from PC Deployment. | | [XtfRegisterPackage](/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m) | Registers a package deployed to the title scratch drive. | | [XtfRegisterPackageOnDrive](/reference/tools/xtf/xtfapi/functions/xtfregisterpackageondrive-xtfapi-xbox-windows-m) | Registers a package deployed on the specified drive. | | [XtfUnregisterPackage](/reference/tools/xtf/xtfapi/functions/xtfunregisterpackage-xtfapi-xbox-windows-m) | Unregisters a package deployed to the title scratch drive. | ## Title OS functions | Title OS function | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [XtfCacheTitleOS](/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m) | Adds a Game OS to the OS cache. | | [XtfGetCachedTitleOSVersions](/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m) | Gets the version information of each Game OS cached on the console. | | [XtfGetCachedTitleOSVersionsCallback](/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m) | Callback invoked for each Game OS found by [XtfGetCachedTitleOSVersions](/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m). | | [XtfGetTitleOSFourPartVersion](/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m) | Gets version information about the Game OS for the currently running title. | | [XtfGetTitleOSState](/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m) | Query the state of the Title OS, Fast Iteration Mode, running Title, associate PID, and Package information. | | [XtfGetTitleProcessMemoryReports](/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m) | Reserved for internal use. | | [XtfRemoveTitleOSFromCache](/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcache-xtfapi-xbox-windows-m) | Removes a Game OS from the cache on the console. | | [XtfRemoveTitleOSFromCacheByVersion](/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcachebyversion-xtfapi-xbox-windows-m) | Removes the Game OS matching the specified [FourPartVersion](/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s) from the cache on the console. | | [XtfShutdownTitleOS](/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m) | Shuts down the active title and Game OS. | | [XtfStartTitleOS](/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m) | Starts or restarts the specified Game OS. | | [XtfStartTitleOSByGameConfig](/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbygameconfig-xtfapi-xbox-windows-m) | Starts or restarts the Game OS based on the contents of a MicrosoftGame.config file that is stored in memory as a string. | | [XtfStartTitleOSByVersion](/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbyversion-xtfapi-xbox-windows-m) | Starts or restarts the Game OS matching the specified [FourPartVersion](/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s) from the cache on the console. | ## Overlay Folder functions | Overlay Folder function | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | | [XtfClearAllOverlayFolders](/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m) | Clears the Overlay Folder paths for all packages installed/registered on the console. | | [XtfGetOverlayFolder](/reference/tools/xtf/xtfapi/functions/xtfgetoverlayfolder-xtfapi-xbox-windows-m) | Gets the Overlay Folder path for a specified package. | | [XtfSetOverlayFolder](/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m) | Sets the Overlay Folder path for a specified package. | ## Structures | Structure | Description | | -------------------------------------------------------------------------------------------- | ------------------------------------------ | | [FourPartVersion](/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s) | The four-part version number of a Game OS. | ## Enumerations | Enumeration | Description | | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | [XtfConsoleCertType Enumeration](/reference/tools/xtf/xtfapi/enums/xtfconsolecerttype-xbox-windows-t) | Reserved for internal use. | | [XtfConsoleFieldId Enumeration](/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t) | Identifies the value to return from [XtfGetConsoleFieldValue](/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m). | | [XtfConsoleFieldType Enumeration](/reference/tools/xtf/xtfapi/enums/xtfconsolefieldtype-xbox-windows-t) | Identifies the type of the value returned from XtfGetConsoleFieldValue. | ## Related topics - [XtfRegisterPackage](/ja-jp/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m.md) - [XtfAddCredential](/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m.md) - [XtfCacheTitleOS](/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m.md) - [XtfShutdownTitleOS](/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m.md) - [XtfStartTitleOS](/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m.md)