P&E Microcomputer Systems Cyclone LC Series User Manual page 81

latest images on a server).
@parameter cycloneHandle
@parameter selectedMediaType
@returnvalue
8.2.4.5.4 eraseCycloneImage
bool eraseCycloneImage(uint32_t cycloneHandle, uint32_t imageId);
This function erase the specified image that is stored on the Cyclone. This function is not
supported by legacy Cyclone. It is recommended that the user make use of the
"compareImageInCycloneWithFile" function first to determine if an erase is indeed necessary. (e.g.
if the images on the Cyclone do not match the latest images on a server).
@parameter cycloneHandle
@parameter imageId
@returnvalue
8.2.4.5.5 addCycloneImage
uint32_t addCycloneImage(uint32_t cycloneHandle, uint32_t selectedMediaType, bool
replaceImageOfSameDescription, char *aFile);
This function adds a specified stand-alone programming image into the selected media type. The
image files have a .SAP file extension and are created with the Cyclone Image Creation Utility. If
the Cyclone's storage limits are reached, this routine will return an error.
@parameter cycloneHandle
@parameter selectedMediaType
User Manual For Cyclone LC Programmers
The handle of the Cyclone that will have its images
erased
This parameter selects between Cyclone internal
Flash (selectedMediaType = 1) or external memory
(selectedMediaType =2).
True if the erasure was successful
False otherwise
The handle of the Cyclone that will have its image erased
Selects the image on the Cyclone to use. The valid range of this
parameter is from 1 to the total number of images in the Cyclone
with the count starting from internal memory and then external
memory.
If a Cyclone only stores one image, this parameter is 1.
True if the erasure was successful
False otherwise
The handle of the Cyclone that will accept
the new image
This parameter selects between Cyclone
internal Flash (selectedMediaType = 1) or
external memory (selectedMediaType =2).
81