Cyclone Automated Control Package
33
4.5.3 get_image_description
function get_image_description(cyclonepromaxhandle : longword;
image_id : byte) : pchar;
char *get_image_description(unsigned long cyclonepromaxhandle,
unsigned char image_id);
String get_image_description(UInt32 cyclonepromaxhandle, byte
image_id);
Checks the description of a particular image stored on the selected media
type. (Cyclone internal Flash or external memory card) This description is
specified by the user when the image is first created.
@param
cyclonepromaxhandle
The handle of the Cyclone unit to get an
image description from
@param image_id
Used to select which image stored on the
Cyclone unit to read the description from.
If a Cyclone only stores one image, this
parameter should be set to 1.
The valid range of this parameter is from 1
to the number of images in the selected
media type. (Cyclone internal Flash or
external memory card)
@returnvalue
A pointer to a null-terminated string which
contains the image description
