Sdílet prostřednictvím

LeaderboardReader.BeginRead Method (LeaderboardIdentity, Gamer, Int32, AsyncCallback, Object)

  • Článek

Begins reading a leaderboard asynchronously, and specifies 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 IAsyncResult BeginRead (
         LeaderboardIdentity leaderboardId,
         Gamer pivotGamer,
         int pageSize,
         AsyncCallback callback,
         Object asyncState
)

Parameters

  • leaderboardId
    The leaderboard identity of the leaderboard to read.
  • pivotGamer
    The gamer of interest in the leaderboard. The current page is set so that this gamer appears on the page.
  • pageSize
    The number of leaderboard entries per page.
  • callback
    An AsyncCallback representing the method to call when the leaderboard information is read.
  • asyncState
    A user-created object used to uniquely identify the request, or null.

Return Value

The IAsyncResult used to determine when the asynchronous request is finished.

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

Working with Asynchronous Methods in XNA Game Studio

Reference

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

Platforms

Xbox 360, Windows 7, Windows Vista, Windows XP, Windows Phone 7