LeaderboardReader.Read Method (LeaderboardIdentity, Generic IEnumerable, Gamer, Int32)
Reads a leaderboard synchronously, specifying a leaderboard identity, collection of gamers, 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,
IEnumerable<Gamer> gamers,
Gamer pivotGamer,
int pageSize
)
Parameters
- leaderboardId
The leaderboard identity of the leaderboard to read. - gamers
A collection of gamers to be included in the leaderboard results. This parameter is ignored on Windows Phone. - pivotGamer
The gamer of interest in the leaderboard. The current page will be set so that this gamer will appear on the page. - pageSize
The number of leaderboard entries per 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 will contain the pivotGamer, if this gamer appears on the leaderboard. Otherwise, the top page of leaderboard entries will be 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