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	Réservé à un usage interne.
XtfPullRegisterApp	Réservé à un usage interne.
XtfPullSupplyMock	Réservé à un usage interne.
XtfPullUnregisterApp	Réservé à un usage interne.

Fonctions d’informations sur la console

Fonction d’informations sur la console	Description
XtfCloseConsoleInfoList	Libère les ressources associées à un objet XtfConsoleInfo retourné par XtfGetConsoleInfoList.
XtfGetAvailableSpaceForAppInstallation	Obtient le nombre total d’octets disponibles sur le périphérique de stockage spécifié d’une console de développement.
XtfGetConsoleFieldValue	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	Retourne un objet `XtfConsoleInfo` qui contient des informations sur une console.
XtfGetSavedConsoleAddress	Obtient l’adresse IP Outils de la console par défaut pour les applications XBOX Tools Framework (XTF).
XtfGetSystemUpTime	Obtient la durée, en millisecondes, pendant laquelle le System OS et le Game OS se sont exécutés.
XtfWaitForConsoleOSReady	Attend que le système d’exploitation de la console soit prêt à recevoir des commandes avant de retourner.
XtfWaitForConsoleState	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	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	Libère les ressources associées à un objet XtfNetworkCredentials retourné par XtfGetCredentialInfoList.
XtfGetCredentialInfoCount	Obtient le nombre d’informations d’identification stockées dans un objet `XtfNetworkCredentials` retourné par XtfGetCredentialInfoList.
XtfGetCredentialInfoList	Retourne un objet `XtfNetworkCredentials` qui contient la liste des informations d’identification actuellement stockées sur la console.
XtfGetCredentialServerName	Obtient la partie nom de serveur des informations d’identification stockées à un index dans un objet XtfNetworkCredentials retourné par XtfGetCredentialInfoList.
XtfGetCredentialUserName	Obtient la partie nom d’utilisateur des informations d’identification stockées à un index dans un objet XtfNetworkCredentials retourné par XtfGetCredentialInfoList.
XtfRemoveCredential	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	Démarre la capture de la sortie de débogage.
XtfCaptureOutputEnd	Arrête la capture de la sortie de débogage.
XtfDebugStringCallback	Rappel invoqué pour chaque chaîne de débogage de sortie capturée par XtfCaptureOutputBegin.
XtfDebugStringErrorCallback	Rappel invoqué pour chaque erreur capturée par XtfCaptureOutputBegin.
XtfGetErrorText	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	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	Libère un objet d’informations sur le package.
XtfGetAumid	Obtient l’ID de modèle utilisateur d’application à un index d’un objet d’informations sur le package.
XtfGetCountofAppUserModelIds	Obtient le nombre d’ID de modèle utilisateur d’application d’un objet d’informations sur le package.
XtfGetPackageFullName	Obtient le nom complet du package à partir d’un objet d’informations sur le package.
XtfRegisterAllPackagesOnDrive	Inscrit tous les packages déployés sur le lecteur spécifié.
XtfRegisterNetworkSharePackage	Inscrit un package pour le déploiement Run from PC.
XtfRegisterPackage	Inscrit un package déployé sur le lecteur de travail du titre.
XtfRegisterPackageOnDrive	Inscrit un package déployé sur le lecteur spécifié.
XtfUnregisterPackage	Désinscrit un package déployé sur le lecteur de travail du titre.

Fonctions du Title OS

Fonction du Title OS	Description
XtfCacheTitleOS	Ajoute un Game OS au cache du système d’exploitation.
XtfGetCachedTitleOSVersions	Obtient les informations de version de chaque Game OS mis en cache sur la console.
XtfGetCachedTitleOSVersionsCallback	Rappel invoqué pour chaque Game OS trouvé par XtfGetCachedTitleOSVersions.
XtfGetTitleOSFourPartVersion	Obtient les informations de version du Game OS pour le titre en cours d’exécution.
XtfGetTitleOSState	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	Réservé à un usage interne.
XtfRemoveTitleOSFromCache	Supprime un Game OS du cache sur la console.
XtfRemoveTitleOSFromCacheByVersion	Supprime du cache sur la console le Game OS correspondant à la FourPartVersion spécifiée.
XtfShutdownTitleOS	Arrête le titre actif et le Game OS.
XtfStartTitleOS	Démarre ou redémarre le Game OS spécifié.
XtfStartTitleOSByGameConfig	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	Démarre ou redémarre, à partir du cache sur la console, le Game OS correspondant à la FourPartVersion spécifiée.

Fonctions de dossier de superposition

Fonction de dossier de superposition	Description
XtfClearAllOverlayFolders	Efface les chemins de dossier de superposition pour tous les packages installés/inscrits sur la console.
XtfGetOverlayFolder	Obtient le chemin du dossier de superposition pour un package spécifié.
XtfSetOverlayFolder	Définit le chemin du dossier de superposition pour un package spécifié.

Structures

Structure	Description
FourPartVersion	Numéro de version en quatre parties d’un Game OS.

Énumérations

Énumération	Description
Énumération XtfConsoleCertType	Réservé à un usage interne.
Énumération XtfConsoleFieldId	Identifie la valeur à retourner par XtfGetConsoleFieldValue.
Énumération XtfConsoleFieldType	Identifie le type de la valeur retournée par XtfGetConsoleFieldValue.

Last modified on October 6, 2026

⌘I