LeaderboardReader.BeginRead Method (LeaderboardIdentity, Generic IEnumerable, Gamer, Int32, AsyncCallback, Object)
Begins an asynchronous read of leaderboard data, taking a leaderboard identity, a collection of gamers, a pivot gamer, and a page size.
Syntax
'Declaration
Public Shared Function BeginRead ( _
leaderboardId As LeaderboardIdentity, _
gamers As IEnumerable(Of Gamer), _
pivotGamer As Gamer, _
pageSize As Integer, _
callback As AsyncCallback, _
asyncState As Object _
) As IAsyncResult
public static IAsyncResult BeginRead (
LeaderboardIdentity leaderboardId,
IEnumerable<Gamer> gamers,
Gamer pivotGamer,
int pageSize,
AsyncCallback callback,
Object asyncState
)
public:
static IAsyncResult BeginRead(
LeaderboardIdentity leaderboardId,
IEnumerable<Gamer> gamers,
Gamer pivotGamer,
int pageSize,
AsyncCallback callback,
Object asyncState
)
Parameters
- leaderboardId
Type: LeaderboardIdentity
The leaderboard identity of the leaderboard to read. - gamers
Type: IEnumerable<Gamer>
A collection of gamers that should 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 is set so that this gamer appears on the page. - pageSize
Type: Int32
The number of leaderboard entries per page. - callback
Type: AsyncCallback
An AsyncCallback representing the method to call when the leaderboard information is read. - asyncState
Type: Object
A user-created object used to uniquely identify the request, or null.
Return Value
Type: IAsyncResult
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.
Requirements
Namespace: Microsoft.Xna.Framework.GamerServices
Assembly: Microsoft.Xna.Framework.GamerServices (in microsoft.xna.framework.gamerservices.dll)
See Also
Tasks
Working with Asynchronous Methods in XNA Game Studio
Reference
LeaderboardReader Class
LeaderboardReader Members
Microsoft.Xna.Framework.GamerServices Namespace
Platforms
Windows Phone