EOS API reference page for EOS_Ecom_QueryEntitlements

3 mins to read

This function is part of the Ecom Interface.


Query the entitlement information defined with Epic Online Services. A set of entitlement names can be provided to filter the set of entitlements associated with the account. This data will be cached for a limited time and retrieved again from the backend when necessary. Depending on the number of entitlements passed, the SDK splits the query into smaller batch requests to the backend and aggregates the result. Note: If one of the request batches fails, no data is cached and the entire query is marked as failed. Use EOS_Ecom_CopyEntitlementByIndex, EOS_Ecom_CopyEntitlementByNameAndIndex, and EOS_Ecom_CopyEntitlementById to get the entitlement details. Use EOS_Ecom_GetEntitlementsByNameCount to retrieve the number of entitlements with a specific entitlement name.



Parameter Type And NameUsage Information
EOS_HEcom Handle
const EOS_Ecom_QueryEntitlementsOptions* Optionsstructure containing the account and entitlement names to retrieve
void* ClientDataarbitrary data that is passed back to you in the CompletionDelegate
const EOS_Ecom_OnQueryEntitlementsCallback CompletionDelegatea callback that is fired when the async operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Ecom_OnQueryEntitlementsCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnershipToken

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Ecom_QueryEntitlementsCallbackInfo* DataA EOS_Ecom_QueryEntitlementsCallbackInfo containing the output information and result