> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XblLeaderboardQuery

> XblLeaderboardQuery

# XblLeaderboardQuery

Representa os parâmetros para enviar uma consulta de placar de líderes usando estatísticas baseadas em eventos ou baseadas no título.

## Sintaxe

```cpp theme={null}
typedef struct XblLeaderboardQuery {  
    uint64_t xboxUserId;  
    char scid[XBL_SCID_LENGTH];  
    const char* leaderboardName;  
    const char* statName;  
    XblSocialGroupType socialGroup;  
    const char** additionalColumnleaderboardNames;  
    size_t additionalColumnleaderboardNamesCount;  
    XblLeaderboardSortOrder order;  
    uint32_t maxItems;  
    uint64_t skipToXboxUserId;  
    uint32_t skipResultToRank;  
    const char* continuationToken;  
    XblLeaderboardQueryType queryType;  
} XblLeaderboardQuery  
```

### Membros

*xboxUserId*\
Tipo: uint64\_t

ID de usuário do XBOX opcional do usuário solicitante. Se for um placar de líderes global, defina como 0.

*scid*\
Tipo: char\[XBL\_SCID\_LENGTH]

A ID de configuração de serviço (SCID) do título, codificada em UTF-8.

*leaderboardName*\
Tipo: const char\*

Nome opcional, codificado em UTF-8, do placar de líderes a ser obtido. Defina como nullptr ao consultar um placar de líderes social ou um placar de líderes baseado em estatísticas gerenciadas pelo título.

*statName*\
Tipo: const char\*

Nome opcional, codificado em UTF-8, da estatística para a qual obter um placar de líderes. Usado ao consultar um placar de líderes social ou um placar de líderes baseado em estatísticas gerenciadas pelo título.

*socialGroup*\
Tipo: [XblSocialGroupType](/pt-BR/reference/live/xsapi-c/leaderboard_c/enums/xblsocialgrouptype)

Opcional: o grupo social de usuários para o qual obter resultados do placar de líderes. Por exemplo, para obter um placar de líderes "somente amigos". Defina como XblSocialGroupType\_None para obter um placar de líderes global.

*additionalColumnleaderboardNames*\
Tipo: const char\*\*

Matriz opcional, codificada em UTF-8, de nomes de estatísticas para as colunas adicionais.

*additionalColumnleaderboardNamesCount*\
Tipo: size\_t

Contagem opcional de additionalColumnleaderboardNames passados.

*order*\
Tipo: [XblLeaderboardSortOrder](/pt-BR/reference/live/xsapi-c/leaderboard_c/enums/xblleaderboardsortorder)

Define a ordem de classificação do placar de líderes resultante.

*maxItems*\
Tipo: uint32\_t

Define o número máximo de itens que o placar de líderes resultante contém. Defina como 0 para permitir que o serviço retorne o número máximo padrão de itens.

*skipToXboxUserId*\
Tipo: uint64\_t

Define em torno de qual usuário o placar de líderes resultante é centralizado. Defina como 0 para não pular para um usuário específico.

*skipResultToRank*\
Tipo: uint32\_t

Define em torno de qual classificação o placar de líderes resultante é centralizado. Defina como 0 para não pular para uma classificação específica.

*continuationToken*\
Tipo: const char\*

O continuationToken codificado em UTF-8 usado para obter o próximo conjunto de dados do placar de líderes.

*queryType*\
Tipo: [XblLeaderboardQueryType](/pt-BR/reference/live/xsapi-c/leaderboard_c/enums/xblleaderboardquerytype)

O tipo de placar de líderes a ser consultado.

## Membro de

[XblLeaderboardResult](/pt-BR/reference/live/xsapi-c/leaderboard_c/structs/xblleaderboardresult)

## Argumento de

[XblLeaderboardGetLeaderboardAsync](/pt-BR/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardgetleaderboardasync)

## Comentários

### Estatísticas baseadas em eventos

Ao usar o membro *statName* com [estatísticas baseadas em eventos](/pt-BR/services/xbox-services/player-data/stats-leaderboards/event-based/live-stats-eb-overview), o valor deve coincidir com uma [instância de estatística](/pt-BR/services/xbox-services/player-data/stats-leaderboards/event-based/live-stats-eb-overview#defining-stat-instances).

### Estatísticas gerenciadas pelo título

Ao usar [estatísticas gerenciadas pelo título](/pt-BR/services/xbox-services/player-data/stats-leaderboards/title-managed/live-stats-tm-overview) para placares de líderes, definir *skipToXboxUserId* com um valor diferente de zero compara a estatística armazenada do *xboxUserId* fornecido com o placar de líderes global.

Da mesma forma, definir *socialGroup* como People ou Favorites compara as estatísticas armazenadas do *xboxUserId* fornecido e dos usuários associados. Os valores do placar de líderes global não são usados.

**Observe que, quando a estatística armazenada de um jogador e sua pontuação no placar de líderes global não são iguais, isso pode gerar resultados incompatíveis.**

<Info>
  Para estatísticas gerenciadas pelo título, a entrada de um jogador no placar de líderes global não é uma projeção direta da estatística armazenada atual dele. O serviço de placar de líderes **mantém apenas o maior valor registrado** para cada jogador. Como resultado, **gravar um valor menor em uma estatística não reduz a posição desse jogador no placar de líderes global**; o placar de líderes continua refletindo o máximo registrado anteriormente. A própria estatística armazenada, que pode ser consultada por meio de `XblUserStatisticsGet*` ou `XblTitleManagedStatsGetForUserAsync`, reflete o valor gravado mais recentemente, e é por isso que ela pode divergir do placar de líderes.

  Se o seu título precisar que as posições no placar de líderes diminuam, as estatísticas gerenciadas pelo título não são adequadas. Exemplos incluem uma classificação que sobe ou desce, ou uma pontuação que é redefinida em caso de derrotas. Em vez disso, considere estatísticas baseadas em eventos com uma regra `Replace` ou um serviço de placar de líderes externo, como o [PlayFab Leaderboards v2](/pt-BR/services/playfab/community/leaderboards/index). Para obter mais informações sobre esse comportamento, consulte as [Notas de implementação](https://github.com/microsoft/Xbox-GDK-Samples/blob/main/Samples/Live/LeaderboardsTitleManaged/readme_en-us.md) do exemplo `LeaderboardsTitleManaged` do Microsoft Game Development Kit (GDK).
</Info>

## Requisitos

**Cabeçalho:** leaderboard\_c.h

## Confira também

[leaderboard\_c](/pt-BR/reference/live/xsapi-c/leaderboard_c/leaderboard_c_members)\
[Estatísticas baseadas em eventos versus estatísticas gerenciadas pelo título](/pt-BR/services/xbox-services/player-data/stats-leaderboards/live-stats-eb-vs-tm)


## Related topics

- [XblLeaderboardQuery](/reference/live/xsapi-c/leaderboard_c/structs/xblleaderboardquery.md)
- [XblLeaderboardQueryType](/reference/live/xsapi-c/leaderboard_c/enums/xblleaderboardquerytype.md)
- [Leaderboards](/build/steam-porting-guide/features/steam-leaderboards.md)
- [Getting a title-managed leaderboard](/services/xbox-services/player-data/stats-leaderboards/title-managed/how-to/live-getting-tm-leaderboard.md)
- [XblLeaderboardGetLeaderboardAsync](/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardgetleaderboardasync.md)
