XGameEventWrite
编写可选地包含“维度”和“度量”数据字段的游戏内事件。
语法
HRESULT XGameEventWrite(
XUserHandle user,
const char *serviceConfigId,
const char *playSessionId,
const char* eventName,
const char* dimensionsJson,
const char* measurementsJson
)
参数
user _In_
类型：XUserHandle
作为代表发送事件的用户句柄。
*
serviceConfigId _In_z_
类型：char
此游戏的 Xbox Live 服务配置 ID (SCID)。
*
playSessionId _In_z_
类型：char
游戏会话 ID。 这是在每个游戏会话的一开始由游戏创建的唯一 GUID，用于跟踪在单个游戏会话中发送的事件集。
eventName _In_z_
类型：char*
事件名称。
dimensionsJson _In_opt_z_
类型：char*
JSON 格式的维度数据字段。
measurementsJson _In_opt_z_
类型：char*
JSON 格式的度量数据字段。
返回值
类型：HRESULT
如果成功，则返回 S_OK；否则返回错误代码。 有关错误代码的列表，请参阅错误代码。
备注
注意
在时间敏感线程上调用此函数是不安全的。 有关详细信息，请参阅时间敏感线程。
维度包括具有有限数量的已定义数字或字符串值的事件字段。 维度示例：地图 ID、难度级别、角色或武器类别、游戏模式、布尔设置等。度量包括表示标量数字指标的事件字段。 度量示例：得分、时间、计数器、位置等。示例：对于跟踪某个难度级别的最高匹配分数的游戏内事件：难度级别应包含在维度中，而分数应包含在度量中。 维度和度量中事件的名称以及事件字段的名称必须与游戏的服务配置中声明的名称匹配。 名称不区分大小写。 如果 API 写入的事件的名称与服务配置中的名称不匹配，则服务将删除该事件而不发出通知。
要求
头文件： XGameEvent.h
库：xgameruntime.lib
支持平台：Windows、Xbox One 系列主机和 Xbox Series 主机