XUser
Documentation de référence pour les API XUser.Fonctions
| Fonction | Description |
|---|---|
| XUserAddAsync | Ajoute de façon asynchrone un utilisateur à une session de jeu. |
| XUserAddByIdWithUiAsync | Ajoute de façon asynchrone un utilisateur à une session de jeu en fonction 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 que XUserAddByIdWithUiAsync crée. Cette fonction ne doit être utilisée qu’en réponse à une invitation de jeu. |
| XUserAddResult | Récupère un handle vers un utilisateur que XUserAddAsync crée. |
| XUserChangeEventCallback | Un rappel qu’une application définit pour un événement de modification d’utilisateur. |
| XUserCheckPrivilege | Détermine si un utilisateur possède 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 deux handles d’utilisateur pour déterminer leur égalité. |
| XUserDefaultAudioEndpointUtf16ChangedCallback | Un rappel qu’une application définit et appelle lorsque le point de terminaison audio par défaut d’un utilisateur change. |
| XUserDeviceAssociationChangedCallback | Un rappel qui est appelé lorsque l’association utilisateur-périphérique change. |
| XUserDuplicateHandle | Duplique un handle d’utilisateur. |
| XUserFindControllerForUserWithUiAsync | Affiche une boîte de dialogue qui invite l’utilisateur à allumer et à identifier la manette qu’il souhaite utiliser. |
| XUserFindControllerForUserWithUiResult | Récupère l’ID de périphérique local de l’application (APP_LOCAL_DEVICE_ID) qu’un utilisateur a choisi d’utiliser. |
| XUserFindForDevice | Récupère l’ID d’utilisateur pour un ID de périphérique spécifique. |
| XUserFindUserById | Récupère l’ID d’utilisateur XBox (XUID) d’un utilisateur local. |
| XUserFindUserByLocalId | Récupère un handle vers l’utilisateur pour un ID d’utilisateur local spécifique. |
| XUserGetAgeGroup | Retourne le groupe 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 façon asynchrone l’image du joueur d’un utilisateur spécifique. |
| XUserGetGamerPictureResult | Récupère le résultat d’un appel à XUserGetGamerPictureAsync. |
| XUserGetGamerPictureResultSize | Retourne la taille de mémoire tampon dont XUserGetGamerPictureResult a besoin pour récupérer l’image du joueur que XUserGetGamerPictureAsync retourne. |
| XUserGetGamertag | Récupère le gamertag d’un utilisateur spécifique. |
| XUserGetId | Obtient l’ID d’utilisateur d’un utilisateur spécifique. |
| XUserGetIsGuest | Retourne une valeur booléenne qui indique si un utilisateur est un invité. |
| XUserGetLocalId | Récupère un ID de session de jeu unique pour un utilisateur. |
| XUserGetMaxUsers | Récupère le nombre maximal d’utilisateurs qu’une session de jeu autorise sur la plateforme actuelle. |
| XUserGetMsaTokenSilentlyAsync | Cette fonction est maintenant dépréciée. |
| XUserGetMsaTokenSilentlyResult | Cette fonction est maintenant dépréciée. |
| XUserGetMsaTokenSilentlyResultSize | Cette fonction est maintenant 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 façon 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 nécessaire pour contenir les résultats d’un appel à XUserGetTokenAndSignatureAsync. |
| XUserGetTokenAndSignatureUtf16Async | Récupère de façon 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 nécessaire pour 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 que l’application définit et appelle lorsque le point de terminaison audio par défaut change. |
| XUserRegisterForDeviceAssociationChanged | Inscrit un rappel pour les événements de modification de l’association entre l’utilisateur et le périphérique. |
| 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 | Annule l’inscription d’un rappel de modification d’utilisateur inscrit précédemment. |
| XUserUnregisterForDefaultAudioEndpointUtf16Changed | Annule l’inscription d’un rappel de modification du point de terminaison audio par défaut inscrit précédemment. |
| XUserUnregisterForDeviceAssociationChanged | Annule l’inscription d’un rappel de modification de l’association entre l’utilisateur et le périphérique inscrit précédemment. |
| 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 pour l’authentification par connexion à distance. |
| XUserPlatformRemoteConnectClosePromptEventHandler | Gestionnaire d’événements de fermeture de l’invite pour l’authentification à distance. |
| XUserPlatformSpopPromptEventHandler | Gestionnaire d’événements d’affichage de l’invite pour une 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 de périphérique lorsqu’une association de périphérique change. |
| XUserGetTokenAndSignatureData | Spécifie les xtokens et les signatures que nous récupérons 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 le groupe 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 effectue le rendu ou la capture audio. |
| XUserGamerPictureSize | Spécifie la taille de l’image du joueur en pixels. |
| XUserGamertagComponent | Spécifie le type (ou composant) de gamertag à extraire. |
| 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 de l’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 sensibles au temps
- Utilisation des wrappers C# pour les API du GDK dans votre projet Unity
Voir aussi
Référence des API systèmeCodes d’erreur
Les codes d’erreur suivants peuvent être retourné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 requise pour résoudre un problème avec 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 de 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 dans 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 dans 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 dans la configuration du jeu ne correspondent pas à ceux associés au jeu. |