EOS API reference page for EOS_Ecom_RedeemEntitlements

This function is part of the Ecom Interface.


Requests that the provided entitlement be marked redeemed. This will cause that entitlement to no longer be returned from QueryEntitlements unless the include redeemed request flag is set true.


Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_RedeemEntitlementsOptions* Options

structure containing entitlement to redeem

void* ClientData

arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Ecom_OnRedeemEntitlementsCallback CompletionDelegate

a callback that is fired when the async operation completes, either successfully or in error

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_Ecom_OnRedeemEntitlementsCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Ecom_RedeemEntitlements

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Ecom_RedeemEntitlementsCallbackInfo* Data

A EOS_Ecom_RedeemEntitlementsCallbackInfo containing the output information and result

Related API Members