EOS_Ecom_CopyOfferByIndex

EOS API reference page for EOS_Ecom_CopyOfferByIndex

Choose your implementation method:

C

C#

This function is part of the Ecom Interface.

Remarks

Fetches an offer from a given index. The pricing and text are localized to the provided account.

Return Value

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

  • EOS_Ecom_CatalogOfferStale if the offer information is stale and passed out in OutOffer

  • EOS_Ecom_CatalogOfferPriceInvalid if the offer information has an invalid price and passed out in OutOffer

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

  • EOS_NotFound if the offer is not found

See Also

EOS_Ecom_CatalogOffer_Release, EOS_Ecom_GetOfferItemCount

Parameters

EOS_Ecom_CopyOfferByIndex

Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_CopyOfferByIndexOptions* Options

structure containing the Epic Account ID and index being accessed

EOS_Ecom_CatalogOffer** OutOffer

the offer for the given index, if it exists and is valid, use EOS_Ecom_CatalogOffer_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

This function is part of the Ecom Interface.

Remarks

Fetches an offer from a given index. The pricing and text are localized to the provided account. {Result.EcomCatalogOfferStale} if the offer information is stale and passed out in OutOffer {Result.EcomCatalogOfferPriceInvalid} if the offer information has an invalid price and passed out in OutOffer {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.NotFound} if the offer is not found

Return Value

{Result.Success} if the information is available and passed out in OutOffer

See Also

{Release}, {GetOfferItemCount}

Parameters

Ecom.EcomInterface.CopyOfferByIndex

Parameter Type And Name

Usage Information

CopyOfferByIndexOptions options

structure containing the Epic Account ID and index being accessed

CatalogOffer outOffer

the offer for the given index, if it exists and is valid, use EOS_Ecom_CatalogOffer_Release when finished

If successful, this function provides data to the caller through an output parameter. The EOS SDK will automatically handle releasing the data when your code no longer holds any reference to it; you do not need to call a "Release" function.

Related API Members

Tags