Skip to main content

​
XGameEventWrite

Écrit un événement en jeu qui inclut facultativement des champs de données « dimensions » et « measurement ».

​
Syntaxe

​
Paramètres

user   _In_
Type : XUserHandle Handle de l’utilisateur au nom duquel l’événement est envoyé. *serviceConfigId   _In_z_
Type : char ID de configuration de service (SCID) XBOX Live pour ce titre. *playSessionId   _In_z_
Type : char ID de session de jeu. Il s’agit d’un GUID unique créé par le jeu au début de chaque session de jeu pour suivre l’ensemble des événements envoyés au cours d’une même session de jeu. eventName   _In_z_
Type : char* Nom de l’événement. dimensionsJson   _In_opt_z_
Type : char* Champs de données de dimensions au format JSON. measurementsJson   _In_opt_z_
Type : char* Champs de données de mesures au format JSON.

​
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.

​
Remarques

Il n’est pas sécuritaire d’appeler cette fonction sur un thread urgent. Pour plus d’informations, consultez Threads urgents.
Les dimensions comprennent des champs d’événement ayant un nombre fini de valeurs numériques ou de chaînes définies. Exemples de dimensions : ID de carte, niveau de difficulté, classe de personnage ou d’arme, mode de jeu, paramètres booléens, etc. Les mesures comprennent des champs d’événement qui représentent des métriques numériques scalaires. Exemples de mesures : pointage, temps, compteurs, position, etc. Exemple : pour un événement en jeu qui suit le pointage de match le plus élevé pour un niveau de difficulté, le niveau de difficulté doit être inclus dans les dimensions et le pointage doit être inclus dans les mesures. Le nom de l’événement, ainsi que les noms des champs d’événement dans les dimensions et les mesures, doivent correspondre aux noms déclarés dans la configuration de service du titre. Les noms ne respectent pas la casse. Si l’API écrit un événement dont le nom ne correspond à aucun nom de la configuration de service, le service abandonne l’événement sans notification.
Les mesures ne peuvent avoir que des valeurs numériques, tandis que les dimensions peuvent avoir une plus grande variété de types. Si vous le préférez, le champ dimensionsJson peut être utilisé exclusivement pour l’écriture d’événements.

​
Configuration requise

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

​
Documentation conceptuelle

​
Voir aussi

XGameEvent
Last modified on October 6, 2026