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

# XblLeaderboardGetLeaderboardAsync

> XblLeaderboardGetLeaderboardAsync

# XblLeaderboardGetLeaderboardAsync

使用基于事件的统计信息或基于标题的统计信息获取标题的排行榜。

## 语法

```cpp theme={null}
HRESULT XblLeaderboardGetLeaderboardAsync(  
         XblContextHandle xboxLiveContext,  
         XblLeaderboardQuery leaderboardQuery,  
         XAsyncBlock* async  
)  
```

### 参数

*xboxLiveContext*   \_In\_\
类型：[XblContextHandle](/reference/live/xsapi-c/types_c/handles/xblcontexthandle)

使用 XblContextCreateHandle 创建的 XBOX Live 上下文句柄。

*leaderboardQuery*   \_In\_\
类型：[XblLeaderboardQuery](/reference/live/xsapi-c/leaderboard_c/structs/xblleaderboardquery)

排行榜请求的查询参数。

*async*   \_In\_\
类型：XAsyncBlock\*

调用方分配的 AsyncBlock。

### 返回值

类型：HRESULT

此 API 操作的 HRESULT 返回代码。

## REST 调用

V4 GET https: // leaderboards.xboxlive.com/users/xuid({xuid})/scids/{scid}/stats/{statname}/people/{all|favorites}\[?sort=descending|ascending]\&skipToUser={skipToUser}

## 要求

**头文件：** leaderboard\_c.h

**库：** Microsoft.Xbox.Services.14x.GDK.C.lib

## 另请参阅

[leaderboard\_c](/reference/live/xsapi-c/leaderboard_c/leaderboard_c_members)


## Related topics

- [XblLeaderboardGetLeaderboardResult](/zh-CN/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardgetleaderboardresult.md)
- [XblLeaderboardGetLeaderboardResultSize](/zh-CN/reference/live/xsapi-c/leaderboard_c/functions/xblleaderboardgetleaderboardresultsize.md)
- [获取标题管理的排行榜](/zh-CN/services/xbox-services/player-data/stats-leaderboards/title-managed/how-to/live-getting-tm-leaderboard.md)
- [基于事件的排行榜示例代码](/zh-CN/services/xbox-services/player-data/stats-leaderboards/event-based/how-to/live-leaderboards-eb-howto.md)
- [可选服务](/zh-CN/build/gdk-and-engines/optional-services.md)