EOS API reference page for EOS_Achievements_QueryPlayerAchievements

3 분 소요

This function is part of the Achievements Interface.


Query for a list of achievements for a specific player, including progress towards completion for each achievement.

When the Social Overlay is enabled then this will be called automatically. The Social Overlay is enabled by default (see EOS_PF_DISABLE_SOCIAL_OVERLAY).

Return Value

  • EOS_Success if the operation completes successfully

  • EOS_Invalid_ProductUserID if any of the userid options are incorrect

  • EOS_InvalidParameters if any of the other options are incorrect



Parameter Type And NameUsage Information
EOS_HAchievements Handle
const EOS_Achievements_QueryPlayerAchievementsOptions* OptionsStructure containing information about the player whose achievements we're retrieving.
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Achievements_OnQueryPlayerAchievementsCompleteCallback CompletionDelegateThis function is called when the query player achievements operation completes.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Achievements_OnQueryPlayerAchievementsCompleteCallback to report the results of its operation. See the EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo page for more details, or check the [Callback Data] section below.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Achievements_QueryPlayerAchievements

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo* DataAn EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo containing the output information and result

Callback Data

The EOS SDK passes the following data structure to the callback function:


EOS_EResult ResultCodeThe EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors.
void* ClientDataContext that was passed into EOS_Achievements_QueryPlayerAchievements.
EOS_ProductUserId UserIdThe Product User ID of the user who initiated this request.

For more information, see the EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo page.