API reference
API reference
Select your platform
No SDKs available
No versions available

ovr_Leaderboard_GetEntriesByIds Function

Retrieves a block of leaderboard entries that match the specified user IDs. Only entries corresponding to the provided user IDs will be returned. ovrMessage_Leaderboard_GetEntriesByIds will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrLeaderboardEntryArrayHandle. Extract the payload from the message handle with ovr_Message_GetLeaderboardEntryArray().

Signature

ovrRequest ovr_Leaderboard_GetEntriesByIds(const char *leaderboardName, int limit, ovrLeaderboardStartAt startAt, ovrID *userIDs, unsigned int userIDLength)

Parameters

leaderboardName: const char * The name of the leaderboard from which to retrieve entries.
limit: int The maximum number of entries to return.
startAt: ovrLeaderboardStartAt Defines whether to center the query on the user or start at the top of the leaderboard. If this is ovrLeaderboard_StartAtCenteredOnViewer() or ovrLeaderboard_StartAtCenteredOnViewerOrTop(), then the current user's ID will be automatically added to the query.
userIDs: ovrID * Defines a list of user ids to get entries for.
userIDLength: unsigned int The number of user IDs provided.

Returns