XUserAddAsync
Ajoute de façon asynchrone un utilisateur à une session de jeu.Syntaxe
Paramètres
options _In_Type : XUserAddOptions Options d’ajout d’un utilisateur à une session de jeu. async _Inout_
Type : XAsyncBlock* Un XAsyncBlock permettant d’interroger l’état de l’appel et de récupérer les résultats de l’appel.
Valeur de retour
Type : HRESULT Code de réussite ou d’erreur HRESULT. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur.Remarques
XUserAddAsync démarre une opération asynchrone pour ajouter un utilisateur au jeu. Utilisez XUserAddResult pour récupérer les résultats de l’opération. XUserAddAsync affiche toujours une interface utilisateur de sélection de compte, sauf si XUserAddOptions::AddDefaultUserSilently ou XUserAddOptions::AddDefaultUserAllowingUI est passé au paramètre options. Si vous utilisez XUserAddOptions::AddDefaultUserSilently, XUserAddAsync n’affiche pas d’interface utilisateur. Certaines considérations s’appliquent à cette fonction lorsque vous utilisez le modèle utilisateur simplifié (rubrique sous NDA) :- Avec le modèle utilisateur simplifié, les développeurs doivent s’assurer que options est défini sur XUserAddOptions::AddDefaultUserSilently :
- Sur console, les jeux déployés en mode libre (loose) qui utilisent le modèle utilisateur simplifié ne pourront pas être lancés à moins qu’un utilisateur par défaut ne soit déjà connecté.
- Sur PC, les jeux déployés en mode libre (loose) qui utilisent le modèle utilisateur simplifié peuvent être lancés sans utilisateur; toutefois, lorsque le jeu appelle XUserAddAsync, si personne n’est connecté, le jeu sera arrêté et le programme d’amorçage PC (PC Bootstrapper) sera lancé pour aider un utilisateur à se connecter. Les lancements subséquents fonctionneront correctement tant que l’utilisateur est entièrement connecté à XBOX Live.
- Si vous appelez cette fonction à répétition et que l’utilisateur par défaut qui a lancé le jeu est connu, elle retourne ce même utilisateur.
- Si l’utilisateur par défaut précédemment connu s’est déconnecté et qu’un seul utilisateur est connecté sur l’appareil, elle marque cet utilisateur comme nouvel utilisateur « par défaut » et le retourne.
- Si l’utilisateur par défaut précédemment connu s’est déconnecté et que plusieurs utilisateurs sont connectés sur l’appareil, elle retourne E_GAMEUSER_NO_DEFAULT_USER.
- Si vous appelez cette fonction à répétition et que l’utilisateur par défaut qui a lancé le jeu est connu, elle retourne ce même utilisateur.
- Si l’utilisateur par défaut précédemment connu s’est déconnecté et qu’un seul utilisateur est connecté sur l’appareil, elle marque cet utilisateur comme nouvel utilisateur « par défaut » et le retourne.
- Si l’utilisateur qui a initialement lancé le jeu s’est déconnecté et que le nombre d’utilisateurs est de 0 ou supérieur à 1, le système affiche une interface utilisateur pour obtenir l’utilisateur, puis définit cet utilisateur comme utilisateur par défaut.
Configuration requise
En-tête : XUser.h Bibliothèque : xgameruntime.lib Plateformes prises en charge : Windows, Steam Deck, consoles de la famille XBOX One et consoles XBOX SeriesDocumentation conceptuelle
- Exécuter une tâche d’API du Microsoft Game Development Kit (GDK)
- Objectifs de conception et améliorations de la programmation asynchrone
- Implémenter la connexion des joueurs dans votre jeu
- Présentation de Game Chat 2
- Utilisation de l’API C++ de Game Chat 2
- Implémenter la connexion des joueurs
