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_CatalogOfferStale if the associated offer information is stale
-
EOS_NotFound if the image is not found
See Also
Parameters
EOS_Ecom_CopyOfferImageInfoByIndex
Parameter Type And Name | Usage Information |
---|---|
EOS_HEcom Handle | |
const EOS_Ecom_CopyOfferImageInfoByIndexOptions* Options | structure containing the offer 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.