LeaderboardReader.Read Method (LeaderboardIdentity, Generic IEnumerable, Gamer, Int32)

Reads a leaderboard synchronously, specifying a leaderboard identity, collection of gamers, pivot gamer, and page size.

Syntax

'Declaration
Public Shared Function Read ( _
         leaderboardId As LeaderboardIdentity, _
         gamers As IEnumerable(Of Gamer), _
         pivotGamer As Gamer, _
         pageSize As Integer _
) As LeaderboardReader 

public static LeaderboardReader Read (
         LeaderboardIdentity leaderboardId,
         IEnumerable<Gamer> gamers,
         Gamer pivotGamer,
         int pageSize
)

public:
static LeaderboardReader Read(
         LeaderboardIdentity leaderboardId,
         IEnumerable<Gamer> gamers,
         Gamer pivotGamer,
         int pageSize
)

Parameters

• leaderboardId
  Type: LeaderboardIdentity
  The leaderboard identity of the leaderboard to read.
• gamers
  Type: IEnumerable<Gamer>
  A collection of gamers to be included in the leaderboard results. This parameter is ignored on Windows Phone.
• pivotGamer
  Type: Gamer
  The gamer of interest in the leaderboard. The current page will be set so that this gamer will appear on the page.
• pageSize
  Type: Int32
  The number of leaderboard entries per page.

Return Value

Type: LeaderboardReader
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.

Requirements

Namespace: Microsoft.Xna.Framework.GamerServices

Assembly: Microsoft.Xna.Framework.GamerServices (in microsoft.xna.framework.gamerservices.dll)

See Also

Tasks

Reference

LeaderboardReader Class
LeaderboardReader Members
Microsoft.Xna.Framework.GamerServices Namespace

Platforms

Windows Phone