Skip to main content

​
XGameEventWrite

Grava um evento no jogo que, opcionalmente, inclui campos de dados de “dimensões” e “medidas”.

​
Sintaxe

​
Parâmetros

user   _In_
Tipo: XUserHandle O identificador do usuário em nome de quem o evento será enviado. *serviceConfigId   _In_z_
Tipo: char A ID de configuração de serviço (SCID) do XBOX Live para este título. *playSessionId   _In_z_
Tipo: char ID da sessão de jogo. Este é um GUID exclusivo criado pelo jogo no início de cada sessão de jogo para rastrear o conjunto de eventos enviados em uma única sessão de jogo. eventName   _In_z_
Tipo: char* Nome do evento. dimensionsJson   _In_opt_z_
Tipo: char* Campos de dados de dimensões no formato JSON. measurementsJson   _In_opt_z_
Tipo: char* Campos de dados de medidas no formato JSON.

​
Valor retornado

Tipo: HRESULT Retornará S_OK se for bem-sucedido; caso contrário, retornará um código de erro. Para obter uma lista de códigos de erro, consulte Códigos de erro.

​
Comentários

Não é seguro chamar esta função em um thread sensível ao tempo. Para obter mais informações, consulte Threads sensíveis ao tempo.
As dimensões incluem campos de evento com um número finito de valores numéricos ou de cadeia de caracteres definidos. Exemplos de dimensões: ID do mapa, nível de dificuldade, classe de personagem ou de arma, modo de jogo, configurações boolianas etc. As medidas incluem campos de evento que representam métricas numéricas escalares. Exemplos de medidas: pontuação, tempo, contadores, posição etc. Exemplo: para um evento no jogo que rastreia a maior pontuação de partida para um nível de dificuldade, o nível de dificuldade deve ser incluído nas dimensões e a pontuação deve ser incluída nas medidas. O nome do evento e os nomes dos campos de evento, tanto nas dimensões quanto nas medidas, devem corresponder aos nomes declarados na configuração de serviço do título. Os nomes não diferenciam maiúsculas de minúsculas. Se a API gravar um evento com um nome que não corresponda a um nome na configuração de serviço, o serviço descartará o evento sem notificação.
As medidas só podem ter valores numéricos, enquanto as dimensões podem ter uma variedade maior de tipos. Se preferir, o campo dimensionsJson pode ser usado exclusivamente para gravar eventos.

​
Requisitos

Cabeçalho: XGameEvent.h Biblioteca: xgameruntime.lib Plataformas compatíveis: Windows, consoles da família XBOX One e consoles XBOX Series

​
Documentação conceitual

​
Confira também

XGameEvent
Last modified on October 6, 2026