Choose your implementation method:
C
C#
This function is part of the Achievements Interface.
Remarks
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
Parameters
EOS_Achievements_QueryDefinitions
|
Parameter Type And Name |
Usage Information |
|---|---|
|
EOS_HAchievements Handle |
|
|
const EOS_Achievements_QueryDefinitionsOptions* Options |
Structure containing information about the application whose achievement definitions we're retrieving. |
|
void* ClientData |
Arbitrary data that is passed back to you in the CompletionDelegate |
|
const EOS_Achievements_OnQueryDefinitionsCompleteCallback CompletionDelegate |
This function is called when the query definitions operation completes. |
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
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
EOS_Achievements_OnQueryDefinitionsCompleteCallback
|
Parameter Type And Name |
Usage Information |
|---|---|
|
const EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo* Data |
An EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo containing the output information and result |
Callback Data
The EOS SDK passes the following data structure to the callback function:
EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo
|
Property |
Value |
|---|---|
|
EOS_EResult ResultCode |
The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. |
|
void* ClientData |
User-defined context that was passed into EOS_Achievements_QueryDefinitions. |
For more information, see the EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo page.
Related API Members
This function is part of the Achievements Interface.
Remarks
Query for a list of definitions for all existing achievements, including localized text, icon IDs and whether an achievement is hidden. {Result.InvalidParameters} if any of the options are incorrect
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
{Result.Success} if the operation completes successfully
Parameters
Achievements.AchievementsInterface.QueryDefinitions
|
Parameter Type And Name |
Usage Information |
|---|---|
|
QueryDefinitionsOptions options |
Structure containing information about the application whose achievement definitions we're retrieving. |
|
object clientData |
Arbitrary data that is passed back to you in the CompletionDelegate |
|
OnQueryDefinitionsCompleteCallback completionDelegate |
This function is called when the query definitions operation completes. |
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Callback Function Information
Because this function is asynchronous, it employs a callback of type Achievements.OnQueryDefinitionsCompleteCallback to report the results of its operation. See the Achievements.OnQueryDefinitionsCompleteCallbackInfo page for more details, or check the Callback Data section below.
Callback Remarks
Function prototype definition for callbacks passed to {AchievementsInterface.QueryDefinitions}
Callback Parameters
Achievements.OnQueryDefinitionsCompleteCallback
|
Parameter Type And Name |
Usage Information |
|---|---|
|
OnQueryDefinitionsCompleteCallbackInfo data |
An EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo containing the output information and result |
Callback Data
The EOS SDK passes the following data structure to the callback function:
Achievements.OnQueryDefinitionsCompleteCallbackInfo
|
Property |
Value |
|---|---|
|
Result ResultCode |
The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. |
|
object ClientData |
User-defined context that was passed into EOS_Achievements_QueryDefinitions. |
For more information, see the Achievements.OnQueryDefinitionsCompleteCallbackInfo page.