EOS API reference page for EOS_Achievements_QueryDefinitions

3 분 소요

This function is part of the Achievements Interface.


Query for a list of definitions for all existing achievements, including localized text, icon IDs and whether an achievement is hidden.

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_InvalidParameters if any of the options are incorrect



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

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Achievements_QueryDefinitions

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo* DataAn EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo 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* ClientDataUser-defined context that was passed into EOS_Achievements_QueryDefinitions.

For more information, see the EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo page.