nn::nex::RankingClient::GetRankingByPIDList Member Function

Syntax

qBool GetRankingByPIDList(
     ProtocolCallContext * pContext,
     qVector< PrincipalID > & principalIdList,
     RankingConstants::RankingMode rankingMode,
     qUnsignedInt32 category,
     const RankingOrderParam & orderParam,
     RankingResult * pResult,
     UniqueId nexUniqueId = INVALID_UNIQUEID
);

Parameters

Name Description
in pContext The call context.
in principalIdList Principal ID to be the ranking target.
in rankingMode The ranking retrieval mode.
in category Category.
in orderParam Parameters for calculating the order.
out pResult The obtained result of rankings.
in nexUniqueId Own NEX unique ID.

Return Values



Value Description
true RMC call initialization succeeded.
false Failure.

Description

Gets the ranking list that has the specified principal ID as the population.

Gets the ranking list of the category specified for the users specified by the principal ID.

When RankingConstants::RANKING_MODE_RANGE (ranking range) is specified in rankingMode, gets the ranking in the users with the specified principal ID. If the player and the friends of the player have scores that are associated with multiple NEX unique IDs all under the same principal ID, all of the ranking data that corresponds to those NEX unique IDs is included. In the ranking range, the nexUniqueId value is ignored.

If RankingConstants::RANKING_MODE_NEAR (nearby rankings) is specified for the ranking mode, gets the nearby ranking of the local host from the users with the specified principal ID. If the local host has scores with multiple NEX unique IDs under the principal ID, the nearby friend ranking list is centered on the scores with the NEX unique IDs that were specified as arguments. In the nearby rankings mode, the offset value specified by orderParam is ignored.

Revision History

2013/01/11
Initial version.

CONFIDENTIAL