Skip to main content

XGameEventWrite

Escribe un evento dentro del juego que opcionalmente incluye campos de datos de “dimensiones” y “mediciones”.

Sintaxis

Parámetros

user   _In_
Tipo: XUserHandle
El identificador del usuario en cuyo nombre se envía el evento. *serviceConfigId   _In_z_
Tipo: char
El identificador de configuración de servicio (SCID) de XBOX Live para este título. *playSessionId   _In_z_
Tipo: char
Identificador de sesión de juego. Se trata de un GUID único creado por el juego al inicio de cada sesión de juego para realizar el seguimiento del conjunto de eventos enviados en una única sesión de juego. eventName   _In_z_
Tipo: char*
Nombre del evento. dimensionsJson   _In_opt_z_
Tipo: char*
Campos de datos de dimensiones en formato JSON. measurementsJson   _In_opt_z_
Tipo: char*
Campos de datos de mediciones en formato JSON.

Valor devuelto

Tipo: HRESULT Devuelve S_OK si se ejecuta correctamente; de lo contrario, devuelve un código de error. Para obtener una lista de códigos de error, consulte Códigos de error.

Comentarios

No es seguro llamar a esta función en un subproceso sensible al tiempo. Para obtener más información, consulte Subprocesos sensibles al tiempo.
Las dimensiones incluyen campos de evento con un número finito de valores numéricos o de cadena definidos. Ejemplos de dimensiones: identificador de mapa, nivel de dificultad, clase de personaje o de arma, modo de juego, configuraciones booleanas, etc. Las mediciones incluyen campos de evento que representan métricas numéricas escalares. Ejemplos de mediciones: puntuación, tiempo, contadores, posición, etc. Ejemplo: para un evento dentro del juego que realiza el seguimiento de la puntuación más alta de una partida para un nivel de dificultad: el nivel de dificultad debe incluirse en las dimensiones y la puntuación debe incluirse en las mediciones. El nombre del evento y los nombres de los campos del evento, tanto en dimensiones como en mediciones, deben coincidir con los nombres declarados en la configuración de servicio del título. Los nombres no distinguen mayúsculas de minúsculas. Si la API escribe un evento con un nombre que no coincide con un nombre de la configuración de servicio, el servicio descarta el evento sin ninguna notificación.
Las mediciones solo pueden tener valores numéricos, mientras que las dimensiones pueden tener una variedad más amplia de tipos. Si se prefiere, el campo dimensionsJson puede usarse exclusivamente para escribir eventos.

Requisitos

Encabezado: XGameEvent.h Biblioteca: xgameruntime.lib Plataformas compatibles: Windows, consolas de la familia XBOX One y consolas XBOX Series

Documentación conceptual

Consulte también

XGameEvent
Última modificación el 28 de agosto de 2026