EOS_Ecom_CopyItemImageInfoByIndex

EOS API reference page for EOS_Ecom_CopyItemImageInfoByIndex

1 min to read

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 NameUsage Information
EOS_HEcom Handle
const EOS_Ecom_CopyItemImageInfoByIndexOptions* Optionsstructure containing the item ID and index being accessed
EOS_Ecom_KeyImageInfo** OutImageInfothe 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.