Skip to main content

​
XSystemGetConsoleId

Retourne l’ID de console de l’appareil actuel.

​
Syntaxe

​
Paramètres

consoleIdSize   _In_
Type : size_t Taille de consoleId, en octets. Cette valeur doit être supérieure ou égale à la constante XSystemConsoleIdBytes définie dans XSystem.h. consoleId   _Out_writes_bytes_to_(consoleIdSize,*consoleIdUsed)
Type : char* Mémoire tampon de caractères qui recevra l’ID de console. consoleIdUsed   _Out_opt_
Type : size_t* Taille, en octets, de la mémoire tampon consoleId retournée.

​
Valeur de retour

Type : HRESULT Retourne S_OK en cas de réussite; sinon, retourne un code d’erreur. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur. Si la fonction échoue parce que consoleIdSize est défini sur une valeur inférieure à XSystemConsoleIdBytes, la valeur de retour est définie sur HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER).

​
Remarques

Il n’est pas sécuritaire d’appeler cette fonction sur un thread sensible au temps. Pour plus d’informations, consultez Threads sensibles au temps.
L’ID de console identifie de façon unique un appareil XBOX pour XBOX Live, dans les scénarios de développement seulement. L’ID de console sert à identifier la console à des fins de journalisation et de gestion; par exemple, pour capturer des informations d’analyse ou pour déterminer quelle trousse de développement redémarrer dans un environnement de développement. L’ID retourné par cette fonction correspond à l’ID de console visible dans Paramètres \ Système \ Informations sur la console. Pour les appareils XBOX, l’ID de console est stocké sur l’appareil. Si l’ID de console est introuvable, ou si vous n’avez pas l’autorisation d’accéder à l’ID de console, l’ID de console prend la valeur par défaut 00000000.00000000.00000000.00000000.00. Pour les appareils PC, l’ID de console prend toujours la valeur par défaut 00000000.00000000.00000000.00000000.00. En mode RETAIL, cette fonction retourne toujours 00000000.00000000.00000000.00000000.00. Si le jeu a besoin d’un identificateur pouvant être utilisé dans toutes les situations, y compris en mode Retail, il existe deux possibilités :
  • Si votre application utilise l’authentification unique (SSO), vous devez utiliser l’ID par paire (pairwise ID) du jeton SSO XSTS au lieu de l’ID retourné par cette fonction.
  • Sinon, utilisez la fonction XSystemGetAppSpecificDeviceId.

​
Configuration requise

En-tête : XSystem.h Bibliothèque : xgameruntime.lib Plateformes prises en charge : Windows, consoles de la famille XBOX One et consoles XBOX Series

​
Documentation conceptuelle

​
Voir aussi

Activation de votre trousse de développement (rubrique sous NDA)
XSystemGetXboxLiveSandbodId
XSystem
Last modified on October 6, 2026