Bagikan melalui

LeaderboardReader.Read Method (LeaderboardIdentity, Gamer, Int32)

  • Artikel

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

Syntax

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

public static LeaderboardReader Read (
         LeaderboardIdentity leaderboardId,
         Gamer pivotGamer,
         int pageSize
)

public:
static LeaderboardReader Read(
         LeaderboardIdentity leaderboardId,
         Gamer pivotGamer,
         int pageSize
)

Parameters

  • leaderboardId
    Type: LeaderboardIdentity
    The leaderboard identity of the leaderboard to read.
  • pivotGamer
    Type: Gamer
    The gamer to center the results on. It can be null.
  • pageSize
    Type: Int32
    The number of leaderboard entries on a page. Pass zero to include all available entries on a single 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 contains the pivotGamer if this gamer appears on the leaderboard. Otherwise, the top page of leaderboard entries is 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