EOS_Ecom_CopyItemById

EOS API reference page for EOS_Ecom_CopyItemById

Choose your implementation method:

C

C#

This function is part of the Ecom Interface.

Remarks

Fetches an item with a given ID.

Return Value

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

  • EOS_Ecom_CatalogItemStale if the item information is stale and passed out in OutItem

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

  • EOS_NotFound if the offer is not found

See Also

EOS_Ecom_CatalogItem_Release, EOS_Ecom_GetItemImageInfoCount, EOS_Ecom_GetItemReleaseCount

Parameters

EOS_Ecom_CopyItemById

Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_CopyItemByIdOptions* Options

structure containing the item ID being accessed

EOS_Ecom_CatalogItem** OutItem

the item for the given index, if it exists and is valid, use EOS_Ecom_CatalogItem_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 item with a given ID. {Result.EcomCatalogItemStale} if the item information is stale and passed out in OutItem {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 OutItem

See Also

{Release}, {GetItemImageInfoCount}, {GetItemReleaseCount}

Parameters

Ecom.EcomInterface.CopyItemById

Parameter Type And Name

Usage Information

CopyItemByIdOptions options

structure containing the item ID being accessed

CatalogItem outItem

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