CloneImageProperties • DefineImageProperty • DeleteImageProperty • DestroyImageProperties • FormatImageProperty • GetImageProperty • GetNextImageProperty • InterpretImageProperties • RemoveImageProperty • ResetImagePropertyIterator • SetImageProperty
CloneImageProperties() clones all the image properties to another image.
The format of the CloneImageProperties method is:
MagickBooleanType CloneImageProperties(Image *image, const Image *clone_image)
A description of each parameter follows:
DefineImageProperty() associates an assignment string of the form "key=value" with an artifact or options. It is equivelent to SetImageProperty().
The format of the DefineImageProperty method is:
MagickBooleanType DefineImageProperty(Image *image, const char *property)
A description of each parameter follows:
DeleteImageProperty() deletes an image property.
The format of the DeleteImageProperty method is:
MagickBooleanType DeleteImageProperty(Image *image,const char *property)
A description of each parameter follows:
DestroyImageProperties() destroys all properties and associated memory attached to the given image.
The format of the DestroyDefines method is:
void DestroyImageProperties(Image *image)
A description of each parameter follows:
FormatImageProperty() permits formatted property/value pairs to be saved as an image property.
The format of the FormatImageProperty method is:
MagickBooleanType FormatImageProperty(Image *image,const char *property, const char *format,...)
A description of each parameter follows.
The image.
The attribute property.
A string describing the format to use to write the remaining arguments.
GetImageProperty() gets a value associated with an image property.
This includes, profile prefixes, such as "exif:", "iptc:" and "8bim:" It does not handle non-prifile prefixes, such as "fx:", "option:", or "artifact:".
The returned string is stored as a properity of the same name for faster lookup later. It should NOT be freed by the caller.
The format of the GetImageProperty method is:
const char *GetImageProperty(const Image *image,const char *key)
A description of each parameter follows:
GetNextImageProperty() gets the next free-form string property name.
The format of the GetNextImageProperty method is:
char *GetNextImageProperty(const Image *image)
A description of each parameter follows:
InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpreted text.
This searches for and replaces \n \r \ replaced by newline, return, and percent resp. < > & replaced by '<', '>', '&' resp. replaced by percent
x [x] where 'x' is a single letter properity, case sensitive). [type:name] where 'type' a is special and known prefix. [name] where 'name' is a specifically known attribute, calculated value, or a per-image property string name, or a per-image 'artifact' (as generated from a global option). It may contain ':' as long as the prefix is not special.
Single letter substitutions will only happen if the character before the percent is NOT a number. But braced substitutions will always be performed. This prevents the typical usage of percent in a interpreted geometry argument from being substituted when the percent is a geometry flag.
If 'glob-expresions' ('*' or '?' characters) is used for 'name' it may be used as a search pattern to print multiple lines of "name=value\n" pairs of the associacted set of properities.
The returned string must be freed using DestoryString() by the caller.
The format of the InterpretImageProperties method is:
char *InterpretImageProperties(const ImageInfo *image_info,Image *image, const char *embed_text)
A description of each parameter follows:
RemoveImageProperty() removes a property from the image and returns its value.
In this case the ConstantString() value returned should be freed by the caller when finished.
The format of the RemoveImageProperty method is:
char *RemoveImageProperty(Image *image,const char *property)
A description of each parameter follows:
ResetImagePropertyIterator() resets the image properties iterator. Use it in conjunction with GetNextImageProperty() to iterate over all the values associated with an image property.
The format of the ResetImagePropertyIterator method is:
ResetImagePropertyIterator(Image *image)
A description of each parameter follows:
SetImageProperty() saves the given string value either to specific known attribute or to a freeform property string.
The format of the SetImageProperty method is:
MagickBooleanType SetImageProperty(Image *image,const char *property, const char *value)
A description of each parameter follows: