LeaderboardReader.Read Method (LeaderboardIdentity, Gamer, Int32)
Reads a leaderboard synchronously, specifying a leaderboard identity, pivot gamer, and page size.
Namespace: Microsoft.Xna.Framework.GamerServices
Assembly: Microsoft.Xna.Framework.GamerServices (in microsoft.xna.framework.gamerservices.dll)
Syntax
public static LeaderboardReader Read (
LeaderboardIdentity leaderboardId,
Gamer pivotGamer,
int pageSize
)
Parameters
- leaderboardId
The leaderboard identity of the leaderboard to read. - pivotGamer
The gamer to center the results on. It can be null. - pageSize
The number of leaderboard entries on a page. Pass zero to include all available entries on a single page.
Return Value
A LeaderboardReader containing the retrieved leaderboard data.
Remarks
Warning
This method retrieves a calculated result only for titles approved to access Xbox LIVE Services through the Xbox LIVE Registered Developer Program. For Xbox LIVE Indie games, this method returns immediately with a predetermined default value.
The returned page of results contains the pivotGamer if this gamer appears on the leaderboard. Otherwise, the top page of leaderboard entries is returned.
See Also
Tasks
Reference
LeaderboardReader Class
LeaderboardReader Members
Microsoft.Xna.Framework.GamerServices Namespace
Platforms
Xbox 360, Windows 7, Windows Vista, Windows XP, Windows Phone 7