EOS_Ecom_CopyLastRedeemedEntitlementByIndex

EOS API reference page for EOS_Ecom_CopyLastRedeemedEntitlementByIndex

2 분 소요

This function is part of the Ecom Interface.

Remarks

Fetches a redeemed entitlement id from a given index. Only entitlements that were redeemed during the last EOS_Ecom_RedeemEntitlements call can be copied.

Return Value

  • EOS_Success if the information is available and passed out in OutRedeemedEntitlementId

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_NotFound if the entitlement id is not found

See Also

EOS_ECOM_ENTITLEMENTID_MAX_LENGTH

Parameters

EOS_Ecom_CopyLastRedeemedEntitlementByIndex

Parameter Type And NameUsage Information
EOS_HEcom Handle
const EOS_Ecom_CopyLastRedeemedEntitlementByIndexOptions* Optionsstructure containing the Epic Account ID and index being accessed
char* OutRedeemedEntitlementIdThe ID of the redeemed entitlement. Must be long enough to hold a string of EOS_ECOM_ENTITLEMENTID_MAX_LENGTH.
int32_t* InOutRedeemedEntitlementIdLengthThe size of the OutRedeemedEntitlementId in characters. The input buffer should include enough space to be null-terminated. When the function returns, this parameter will be filled with the length of the string copied into OutRedeemedEntitlementId.

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.