EOS_Ecom_CopyEntitlementByNameAndIndex

EOS API reference page for EOS_Ecom_CopyEntitlementByNameAndIndex

This function is part of the Ecom Interface.

Remarks

Fetches a single entitlement with a given Entitlement Name. The Index is used to access individual entitlements among those with the same Entitlement Name. The Index can be a value from 0 to one less than the result from EOS_Ecom_GetEntitlementsByNameCount.

Return Value

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

  • EOS_Ecom_EntitlementStale if the entitlement information is stale and passed out in OutEntitlement

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

  • EOS_NotFound if the entitlement is not found

See Also

EOS_Ecom_Entitlement_Release

Parameters

Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_CopyEntitlementByNameAndIndexOptions* Options

structure containing the Epic Online Services Account ID, entitlement name, and index being accessed

EOS_Ecom_Entitlement** OutEntitlement

the entitlement for the given name index pair, if it exists and is valid, use EOS_Ecom_Entitlement_Release when finished

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.

Related API Members