XUser
Documentation de référence des API XUser.Fonctions
| Fonction | Description |
|---|---|
| XUserAddAsync | Ajoute de manière asynchrone un utilisateur à une session de jeu. |
| XUserAddByIdWithUiAsync | Ajoute de manière asynchrone un utilisateur à une session de jeu à partir d’un XUID provenant d’une invitation de jeu. Cette fonction ne doit être utilisée qu’en réponse à une invitation de jeu. |
| XUserAddByIdWithUiResult | Récupère un handle vers l’utilisateur créé par XUserAddByIdWithUiAsync. Cette fonction ne doit être utilisée qu’en réponse à une invitation de jeu. |
| XUserAddResult | Récupère un handle vers un utilisateur créé par XUserAddAsync. |
| XUserChangeEventCallback | Rappel défini par une application pour un événement de modification d’utilisateur. |
| XUserCheckPrivilege | Détermine si un utilisateur dispose d’un privilège spécifique. |
| XUserCloseHandle | Ferme un handle d’utilisateur spécifique. |
| XUserCloseSignOutDeferralHandle | Ferme un handle de report de déconnexion d’utilisateur spécifique. |
| XUserCompare | Compare l’égalité de deux handles d’utilisateur. |
| XUserDefaultAudioEndpointUtf16ChangedCallback | Rappel défini et invoqué par une application lorsque le point de terminaison audio par défaut d’un utilisateur change. |
| XUserDeviceAssociationChangedCallback | Rappel invoqué lorsque l’association entre utilisateur et appareil change. |
| XUserDuplicateHandle | Duplique un handle d’utilisateur. |
| XUserFindControllerForUserWithUiAsync | Affiche une boîte de dialogue invitant l’utilisateur à allumer et identifier la manette qu’il souhaite utiliser. |
| XUserFindControllerForUserWithUiResult | Récupère l’ID d’appareil local de l’application (APP_LOCAL_DEVICE_ID) qu’un utilisateur a choisi d’utiliser. |
| XUserFindForDevice | Récupère l’ID utilisateur correspondant à un ID d’appareil spécifique. |
| XUserFindUserById | Récupère l’ID utilisateur XBox (XUID) d’un utilisateur local. |
| XUserFindUserByLocalId | Récupère un handle vers l’utilisateur correspondant à un ID utilisateur local spécifique. |
| XUserGetAgeGroup | Renvoie la tranche d’âge d’un utilisateur. |
| XUserGetDefaultAudioEndpointUtf16 | Récupère le point de terminaison audio par défaut d’un utilisateur spécifique. |
| XUserGetGamerPictureAsync | Récupère de manière asynchrone l’image de joueur d’un utilisateur spécifique. |
| XUserGetGamerPictureResult | Récupère le résultat d’un appel à XUserGetGamerPictureAsync. |
| XUserGetGamerPictureResultSize | Renvoie la taille de mémoire tampon requise par XUserGetGamerPictureResult pour récupérer l’image de joueur renvoyée par XUserGetGamerPictureAsync. |
| XUserGetGamertag | Récupère le gamertag d’un utilisateur spécifique. |
| XUserGetId | Obtient l’ID utilisateur d’un utilisateur spécifique. |
| XUserGetIsGuest | Renvoie un booléen indiquant si un utilisateur est un invité. |
| XUserGetLocalId | Récupère un ID unique de session de jeu pour un utilisateur. |
| XUserGetMaxUsers | Récupère le nombre maximal d’utilisateurs autorisés par une session de jeu sur la plateforme actuelle. |
| XUserGetMsaTokenSilentlyAsync | Cette fonction est désormais dépréciée. |
| XUserGetMsaTokenSilentlyResult | Cette fonction est désormais dépréciée. |
| XUserGetMsaTokenSilentlyResultSize | Cette fonction est désormais dépréciée. |
| XUserGetSignOutDeferral | Récupère un handle vers le report de déconnexion. |
| XUserGetState | Récupère l’état d’un utilisateur. |
| XUserGetTokenAndSignatureAsync | Récupère de manière asynchrone des xtokens et des signatures pour les requêtes web. |
| XUserGetTokenAndSignatureResult | Obtient le résultat d’un appel à XUserGetTokenAndSignatureAsync. |
| XUserGetTokenAndSignatureResultSize | Obtient la taille de la mémoire tampon destinée à contenir les résultats d’un appel à XUserGetTokenAndSignatureAsync. |
| XUserGetTokenAndSignatureUtf16Async | Récupère de manière asynchrone des xtokens et des signatures Unicode pour les requêtes web. |
| XUserGetTokenAndSignatureUtf16Result | Obtient le résultat d’un appel à XUserGetTokenAndSignatureUtf16Async. |
| XUserGetTokenAndSignatureUtf16ResultSize | Obtient la taille de la mémoire tampon destinée à contenir les résultats d’un appel à XUserGetTokenAndSignatureUtf16Async. |
| XUserIsStoreUser | Vérifie si le MSA de XUser est le même que le MSA connecté au Microsoft Store. |
| XUserRegisterForChangeEvent | Inscrit un rappel pour un événement de modification d’utilisateur. |
| XUserRegisterForDefaultAudioEndpointUtf16Changed | Inscrit un rappel défini et invoqué par l’application lorsque le point de terminaison audio par défaut change. |
| XUserRegisterForDeviceAssociationChanged | Inscrit un rappel pour les événements de modification de l’association entre utilisateur et appareil. |
| XUserResolveIssueWithUiAsync | Affiche une interface utilisateur système permettant de résoudre les problèmes de jeton avec une URL non Unicode. |
| XUserResolveIssueWithUiResult | Récupère le résultat d’un appel à XUserResolveIssueWithUiAsync. |
| XUserResolveIssueWithUiUtf16Async | Affiche une interface utilisateur système permettant de résoudre les problèmes de jeton avec une URL Unicode spécifique. |
| XUserResolveIssueWithUiUtf16Result | Récupère le résultat d’un appel à XUserResolveIssueWithUiUtf16Async. |
| XUserResolvePrivilegeWithUiAsync | Affiche une interface utilisateur de résolution pour les privilèges utilisateur requis. |
| XUserResolvePrivilegeWithUiResult | Récupère le résultat d’un appel à XUserResolvePrivilegeWithUiAsync. |
| XUserUnregisterForChangeEvent | Désinscrit un rappel de modification d’utilisateur précédemment inscrit. |
| XUserUnregisterForDefaultAudioEndpointUtf16Changed | Désinscrit un rappel de modification du point de terminaison audio par défaut précédemment inscrit. |
| XUserUnregisterForDeviceAssociationChanged | Désinscrit un rappel de modification de l’association entre utilisateur et appareil précédemment inscrit. |
| xUserPlatformRemoteConnectSetEventHandlers | Définit les gestionnaires d’événements de connexion à distance |
| XUserPlatformRemoteConnectCancelPrompt | Signale à XUser que l’invite de connexion à distance a été fermée par l’utilisateur. |
| XUserPlatformRemoteConnectShowPromptEventHandler | Gestionnaire d’événements d’affichage de l’invite d’authentification de connexion à distance. |
| XUserPlatformRemoteConnectClosePromptEventHandler | Gestionnaire d’événements de fermeture de l’invite d’authentification à distance. |
| XUserPlatformSpopPromptEventHandler | Gestionnaire d’événements d’affichage de l’invite pour l’opération SPOP |
| XUserPlatformSpopPromptSetEventHandlers | Définit le gestionnaire d’événements de l’invite SPOP. |
| XUserPlatformSpopPromptClearEventHandler | Efface le gestionnaire d’événements de l’invite SPOP dans XUser. |
| XUserPlatformSpopPromptComplete | Signale à XUser que l’utilisateur a terminé d’interagir avec l’invite SPOP. |
Structures
| Structure | Description |
|---|---|
| APP_LOCAL_DEVICE_ID | Spécifie l’ID racine d’un périphérique d’entrée local. |
| XUserDeviceAssociationChange | Spécifie l’ancienne et la nouvelle association d’appareil lorsqu’une association d’appareil change. |
| XUserGetTokenAndSignatureData | Spécifie les xtokens et les signatures récupérés pour les requêtes web. |
| XUserGetTokenAndSignatureHttpHeader | Spécifie l’en-tête HTTP d’une requête web. |
| XUserGetTokenAndSignatureUtf16Data | Contient des xtokens et des signatures Unicode pour les requêtes web. |
| XUserGetTokenAndSignatureUtf16HttpHeader | Contient un en-tête HTTP Unicode pour une requête web. |
| XUserLocalId | Spécifie un ID de session de jeu pour un utilisateur. |
| XUserPlatformRemoteConnectEventHandlers | Encapsule les gestionnaires d’événements de connexion à distance |
Énumérations
| Énumération | Description |
|---|---|
| XUserAddOptions | Spécifie les options d’ajout d’un utilisateur. |
| XUserAgeGroup | Spécifie la tranche d’âge d’un utilisateur. |
| XUserChangeEvent | Spécifie le type d’événement de modification d’utilisateur. |
| XUserDefaultAudioEndpointKind | Spécifie si le point de terminaison audio par défaut de l’utilisateur restitue ou capture l’audio. |
| XUserGamerPictureSize | Spécifie la taille de l’image de joueur en pixels. |
| XUserGamertagComponent | Spécifie le type (ou composant) de gamertag à récupérer. |
| XUserGetMsaTokenSilentlyOptions | Options pour XUserGetMsaTokenSilentlyOptions. |
| XUserGetTokenAndSignatureOptions | Options pour GetUserTokenAndSignatureAsync. |
| XUserPrivilege | Spécifie les privilèges d’un utilisateur. |
| XUserPrivilegeDenyReason | Spécifie la raison pour laquelle un utilisateur n’a pas pu obtenir un privilège. |
| XUserPrivilegeOptions | Spécifie les options de privilège utilisateur. |
| XUserState | Spécifie l’état actuel de l’utilisateur. |
| XUserPlatformOperationResult | Énumération définissant les résultats d’une opération cliente |
| XUserPlatformSpopOperationResult | Énumération définissant les résultats d’une opération cliente. |
Documentation conceptuelle
- Objectifs de conception et améliorations de la programmation asynchrone
- Vue d’ensemble de WinHTTP
- Requêtes web (sommaire)
- Threads à durée critique
- Utilisation des wrappers C# pour les API GDK dans votre projet Unity
Voir aussi
Référence des API systèmeCodes d’erreur
Les codes d’erreur suivants peuvent être renvoyés par les API XUser. Pour obtenir la liste complète, consultez Codes d’erreur.| Code | Valeur | Description |
|---|---|---|
| E_GAMEUSER_MAX_USERS_ADDED | 0x89245100 | Impossible d’ajouter cet utilisateur, car le nombre maximal d’utilisateurs a été atteint. |
| E_GAMEUSER_SIGNED_OUT | 0x89245101 | Impossible d’effectuer l’opération, car l’utilisateur est déconnecté. |
| E_GAMEUSER_RESOLVE_USER_ISSUE_REQUIRED | 0x89245102 | Une IU est nécessaire pour résoudre un problème lié à cet utilisateur. |
| E_GAMEUSER_DEFERRAL_NOT_AVAILABLE | 0x89245103 | Le moment n’est pas approprié pour demander un report. |
| E_GAMEUSER_USER_NOT_FOUND | 0x89245104 | Aucun utilisateur correspondant à l’ID n’a été trouvé. |
| E_GAMEUSER_NO_TOKEN_REQUIRED | 0x89245105 | Aucun jeton n’est requis pour cet appel. |
| E_GAMEUSER_NO_DEFAULT_USER | 0x89245106 | Aucun utilisateur par défaut actuel. Si vous obtenez cette erreur, appelez à nouveau XUserAddAsync sans AddDefaultUserSilently. |
| E_GAMEUSER_FAILED_TO_RESOLVE | 0x89245107 | Échec de la résolution du privilège donné. |
| E_GAMEUSER_NO_TITLE_ID | 0x89245108 | Un TitleId XBOX Live doit être configuré. |
| E_GAMEUSER_UNKNOWN_GAME_IDENTITY | 0x89245109 | L’identité du jeu n’est pas reconnue. Le MSAAppId et le TitleId ne correspondent pas à ceux associés au jeu. |
| E_GAMEUSER_NO_PACKAGE_IDENTITY | 0x89245110 | Une identité de package doit être configurée. |
| E_GAMEUSER_FAILED_TO_GET_TOKEN | 0x89245111 | La demande de jeton a échoué. |
| E_GAMEUSER_INVALID_APP_CONFIGURATION | 0x89245112 | Le MSAAppId de la configuration du jeu n’est pas valide ou n’est pas configuré pour la pile d’authentification. |
| E_GAMEUSER_MALFORMED_MSAAPPID | 0x89245113 | Le MSAAppId de la configuration du jeu ne correspond pas au format attendu (chaîne de 16 caractères ou GUID). |
| E_GAMEUSER_INCONSISTENT_MSAAPPID_AND_TITLEID | 0x89245114 | Le MSAAppId et le TitleId de la configuration du jeu ne correspondent pas à ceux associés au jeu. |