EOS_Ecom_CopyItemImageInfoByIndex

EOS API reference page for EOS_Ecom_CopyItemImageInfoByIndex

Choose your implementation method:

C

C#

This function is part of the Ecom Interface.

Remarks

Fetches an image from a given index.

Return Value

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

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

  • EOS_Ecom_CatalogItemStale if the associated item information is stale

  • EOS_NotFound if the image is not found

See Also

EOS_Ecom_KeyImageInfo_Release

Parameters

EOS_Ecom_CopyItemImageInfoByIndex

Parameter Type And Name

Usage Information

EOS_HEcom Handle

const EOS_Ecom_CopyItemImageInfoByIndexOptions* Options

structure containing the item ID and index being accessed

EOS_Ecom_KeyImageInfo** OutImageInfo

the image for the given index, if it exists and is valid, use EOS_Ecom_KeyImageInfo_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 image from a given index. {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.EcomCatalogItemStale} if the associated item information is stale {Result.NotFound} if the image is not found

Return Value

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

See Also

{Release}

Parameters

Ecom.EcomInterface.CopyItemImageInfoByIndex

Parameter Type And Name

Usage Information

CopyItemImageInfoByIndexOptions options

structure containing the item ID and index being accessed

KeyImageInfo outImageInfo

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