> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Xtf supplémentaires (contenu de l'API)

> API Xtf supplémentaires

# API Xtf supplémentaires

L'API XBOX Tools Framework (XTF) permet de vérifier l'espace disponible pour les applications et de récupérer des messages d'erreur conviviaux.

## Fonctions d'application

| Fonction d'application | Description |
| - | - |
| [XtfPullAuditionApp](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfpullauditionapp-xtfapi-xbox-windows-m.md) | Réservé à un usage interne. |
| [XtfPullRegisterApp](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfpullregisterapp-xtfapi-xbox-windows-m.md) | Réservé à un usage interne. |
| [XtfPullSupplyMock](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfpullsupplymock-xtfapi-xbox-windows-m.md) | Réservé à un usage interne. |
| [XtfPullUnregisterApp](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfpullunregisterapp-xtfapi-xbox-windows-m.md) | Réservé à un usage interne. |

## Fonctions d'informations sur la console

| Fonction d'informations sur la console | Description |
| - | - |
| [XtfCloseConsoleInfoList](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcloseconsoleinfolist-xbox-microsoft-m.md) | Libère les ressources associées à un objet **XtfConsoleInfo** retourné par XtfGetConsoleInfoList. |
| [XtfGetAvailableSpaceForAppInstallation](https://docs.xbox.com/fr/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetavailablespaceforappinstallation-xtfconsolecontrol-xbox-microsoft-m.md) | Obtient le nombre total d'octets disponibles sur le périphérique de stockage spécifié d'une console de développement. |
| [XtfGetConsoleFieldValue](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md) | Récupère une information sur une console, parmi les suivantes : Tools IP Address, Console IP Address, AccessKey, Console ID, HostName, Device ID, DevKit Cert type, SystemMajorVersion, SystemMinorVersion, SystemBuildVersion ou SystemRevisionVersion. |
| [XtfGetConsoleInfoList](https://docs.xbox.com/fr/reference/tools/xtf/xtfconsolecontrol/functions/xtfgetconsoleinfolist-xtfconsolecontrol-xbox-microsoft-m.md) | Retourne un objet `XtfConsoleInfo` qui contient des informations sur une console. |
| [XtfGetSavedConsoleAddress](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetsavedconsoleaddress-xtfapi-xbox-windows-m.md) | Obtient l'adresse IP Outils de la console par défaut pour les applications XBOX Tools Framework (XTF). |
| [XtfGetSystemUpTime](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetsystemuptime-xtfapi-xbox-windows-m.md) | Obtient la durée, en millisecondes, pendant laquelle le System OS et le Game OS se sont exécutés. |
| [XtfWaitForConsoleOSReady](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfwaitforconsoleosready-xtfapi-xbox-windows-m.md) | Attend que le système d'exploitation de la console soit prêt à recevoir des commandes avant de retourner. |
| [XtfWaitForConsoleState](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfwaitforconsolestate.md) | Bloque l'exécution jusqu'à ce que les états de console spécifiés soient atteints ou qu'un délai d'expiration se produise. |

## Fonctions d'informations d'identification

| Fonction d'informations d'identification | Description |
| - | - |
| [XtfAddCredential](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfaddcredential-xtfapi-xbox-windows-m.md) | Ajoute des informations d'identification (nom d'utilisateur et mot de passe) à la console donnée pour une utilisation par le déploiement Run from PC. |
| [XtfCloseCredentialInfoList](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfclosecredentialinfo-xtfapi-xbox-windows-m.md) | Libère les ressources associées à un objet XtfNetworkCredentials retourné par XtfGetCredentialInfoList. |
| [XtfGetCredentialInfoCount](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfocount-xtfapi-xbox-windows-m.md) | Obtient le nombre d'informations d'identification stockées dans un objet `XtfNetworkCredentials` retourné par [XtfGetCredentialInfoList](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md). |
| [XtfGetCredentialInfoList](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcredentialinfolist-xtfapi-xbox-windows-m.md) | Retourne un objet `XtfNetworkCredentials` qui contient la liste des informations d'identification actuellement stockées sur la console. |
| [XtfGetCredentialServerName](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcredentialtargetname-xtfapi-xbox-windows-m.md) | Obtient la partie nom de serveur des informations d'identification stockées à un index dans un objet XtfNetworkCredentials retourné par XtfGetCredentialInfoList. |
| [XtfGetCredentialUserName](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcredentialusername-xtfapi-xbox-windows-m.md) | Obtient la partie nom d'utilisateur des informations d'identification stockées à un index dans un objet XtfNetworkCredentials retourné par XtfGetCredentialInfoList. |
| [XtfRemoveCredential](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfremovecredential-xtfapi-xbox-windows-m.md) | Supprime des informations d'identification de la console donnée. Utilisez XtfAddCredential pour ajouter des informations d'identification. |

## Fonctions de débogage

| Fonction de débogage | Description |
| - | - |
| [XtfCaptureOutputBegin](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md) | Démarre la capture de la sortie de débogage. |
| [XtfCaptureOutputEnd](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputend-xtfapi-xbox-windows-m.md) | Arrête la capture de la sortie de débogage. |
| [XtfDebugStringCallback](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfdebugstringcallback-xtfapi-xbox-windows-m.md) | Rappel invoqué pour chaque chaîne de débogage de sortie capturée par [XtfCaptureOutputBegin](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md). |
| [XtfDebugStringErrorCallback](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfdebugstringerrorcallback-xtfapi-xbox-windows-m.md) | Rappel invoqué pour chaque erreur capturée par [XtfCaptureOutputBegin](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md). |
| [XtfGetErrorText](https://docs.xbox.com/fr/reference/tools/xtf/xtfconsolecontrol/functions/xtfgeterrortext-xtfconsolecontrol-xbox-microsoft-m.md) | Obtient un message d'erreur convivial et un texte d'action pour le `HRESULT` spécifié. |

## Fonctions de clip de jeu

| Fonction de clip de jeu | Description |
| - | - |
| [XtfCaptureRecordedGameClip](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m.md) | Capture un clip vidéo du jeu en cours d'exécution. |

## Fonctions d'informations sur les packages

| Fonction d'informations sur les packages | Description |
| - | - |
| [XtfClosePackageInfo](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfclosepackageinfo-xtfapi-xbox-windows-m.md) | Libère un objet d'informations sur le package. |
| [XtfGetAumid](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetaumid-xtfapi-xbox-windows-m.md) | Obtient l'ID de modèle utilisateur d'application à un index d'un objet d'informations sur le package. |
| [XtfGetCountofAppUserModelIds](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcountofappusermodelids-xtfapi-xbox-windows-m.md) | Obtient le nombre d'ID de modèle utilisateur d'application d'un objet d'informations sur le package. |
| [XtfGetPackageFullName](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetpackagefullname-xtfapi-xbox-windows-m.md) | Obtient le nom complet du package à partir d'un objet d'informations sur le package. |
| [XtfRegisterAllPackagesOnDrive](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfregisterallpackagesondrive-xtfapi-xbox-windows-m.md) | Inscrit tous les packages déployés sur le lecteur spécifié. |
| [XtfRegisterNetworkSharePackage](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfregisternetworksharepackage-xtfapi-xbox-windows-m.md) | Inscrit un package pour le déploiement Run from PC. |
| [XtfRegisterPackage](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfregisterpackage-xtfapi-xbox-windows-m.md) | Inscrit un package déployé sur le lecteur de travail du titre. |
| [XtfRegisterPackageOnDrive](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfregisterpackageondrive-xtfapi-xbox-windows-m.md) | Inscrit un package déployé sur le lecteur spécifié. |
| [XtfUnregisterPackage](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfunregisterpackage-xtfapi-xbox-windows-m.md) | Désinscrit un package déployé sur le lecteur de travail du titre. |

## Fonctions du Title OS

| Fonction du Title OS | Description |
| - | - |
| [XtfCacheTitleOS](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfcachetitleos-xtfapi-xbox-windows-m.md) | Ajoute un Game OS au cache du système d'exploitation. |
| [XtfGetCachedTitleOSVersions](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md) | Obtient les informations de version de chaque Game OS mis en cache sur la console. |
| [XtfGetCachedTitleOSVersionsCallback](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversionscallback-xtfapi-xbox-windows-m.md) | Rappel invoqué pour chaque Game OS trouvé par [XtfGetCachedTitleOSVersions](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetcachedtitleosversions-xtfapi-xbox-windows-m.md). |
| [XtfGetTitleOSFourPartVersion](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgettitleosfourpartversion-xtfapi-xbox-windows-m.md) | Obtient les informations de version du Game OS pour le titre en cours d'exécution. |
| [XtfGetTitleOSState](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgettitleosstate-xtfapi-xbox-windows-m.md) | Interroge l'état du Title OS, du mode d'itération rapide, du titre en cours d'exécution, du PID associé et des informations sur le package. |
| [XtfGetTitleProcessMemoryReports](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgettitleprocessmemoryreports-xtfapi-xbox-windows-m.md) | Réservé à un usage interne. |
| [XtfRemoveTitleOSFromCache](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcache-xtfapi-xbox-windows-m.md) | Supprime un Game OS du cache sur la console. |
| [XtfRemoveTitleOSFromCacheByVersion](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfremovetitleosfromcachebyversion-xtfapi-xbox-windows-m.md) | Supprime du cache sur la console le Game OS correspondant à la [FourPartVersion](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) spécifiée. |
| [XtfShutdownTitleOS](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfshutdowntitleos-xtfapi-xbox-windows-m.md) | Arrête le titre actif et le Game OS. |
| [XtfStartTitleOS](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfstarttitleos-xtfapi-xbox-windows-m.md) | Démarre ou redémarre le Game OS spécifié. |
| [XtfStartTitleOSByGameConfig](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbygameconfig-xtfapi-xbox-windows-m.md) | Démarre ou redémarre le Game OS en fonction du contenu d'un fichier MicrosoftGame.config stocké en mémoire sous forme de chaîne. |
| [XtfStartTitleOSByVersion](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfstarttitleosbyversion-xtfapi-xbox-windows-m.md) | Démarre ou redémarre, à partir du cache sur la console, le Game OS correspondant à la [FourPartVersion](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) spécifiée. |

## Fonctions de dossier de superposition

| Fonction de dossier de superposition | Description |
| - | - |
| [XtfClearAllOverlayFolders](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m.md) | Efface les chemins de dossier de superposition pour tous les packages installés/inscrits sur la console. |
| [XtfGetOverlayFolder](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetoverlayfolder-xtfapi-xbox-windows-m.md) | Obtient le chemin du dossier de superposition pour un package spécifié. |
| [XtfSetOverlayFolder](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m.md) | Définit le chemin du dossier de superposition pour un package spécifié. |

## Structures

| Structure | Description |
| - | - |
| [FourPartVersion](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/structs/fourpartversion-xtfapi-xbox-windows-s.md) | Numéro de version en quatre parties d'un Game OS. |

## Énumérations

| Énumération | Description |
| - | - |
| [Énumération XtfConsoleCertType](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/enums/xtfconsolecerttype-xbox-windows-t.md) | Réservé à un usage interne. |
| [Énumération XtfConsoleFieldId](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/enums/xtfconsolefieldid-xbox-windows-t.md) | Identifie la valeur à retourner par [XtfGetConsoleFieldValue](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md). |
| [Énumération XtfConsoleFieldType](https://docs.xbox.com/fr/reference/tools/xtf/xtfapi/enums/xtfconsolefieldtype-xbox-windows-t.md) | Identifie le type de la valeur retournée par XtfGetConsoleFieldValue. |


## Related topics

- [XtfUser (contenu de l'API)](https://docs.xbox.com/fr/reference/tools/xtf/xtfuser/xtfuser-xbox-windows-n.md)
- [XtfApplication (contenu de l'API)](https://docs.xbox.com/fr/reference/tools/xtf/xtfapplication/xtfapplication-xbox-microsoft-n.md)
- [XtfInput (contenu de l'API)](https://docs.xbox.com/fr/reference/tools/xtf/xtfinput/xtfinput-xbox-microsoft-n.md)
- [XtfFileIO (contenu de l'API)](https://docs.xbox.com/fr/reference/tools/xtf/xtffileio/xtffileio-xbox-microsoft-n.md)
- [XtfDebugMonitor (contenu de l'API)](https://docs.xbox.com/fr/reference/tools/xtf/xtfdebugmonitor/xtfdebugmonitor-xbox-microsoft-n.md)
