Module property Methods

CloneImageProperties() clones one or more image properties.

The format of the CloneImageProperties method is:

  MagickBooleanType CloneImageProperties(Image *image,
    const Image *clone_image)

A description of each parameter follows:

image

the image.

clone_image

the clone image.

DefineImageProperty() associates a key/value pair with an image property.

The format of the DefineImageProperty method is:

  MagickBooleanType DefineImageProperty(Image *image,
    const char *property)

A description of each parameter follows:

image

the image.

property

the image property.

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:

image

the image.

property

the image property.

DestroyImageProperties() releases memory associated with image property values.

The format of the DestroyDefines method is:

  void DestroyImageProperties(Image *image)

A description of each parameter follows:

image

the image.

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.

image

The image.

property

The attribute property.

format

A string describing the format to use to write the remaining arguments.

GetImageProperty() gets a value associated with an image property.

The format of the GetImageProperty method is:

  const char *GetImageProperty(const Image *image,const char *key)

A description of each parameter follows:

image

the image.

key

the key.

GetNextImageProperty() gets the next image property value.

The format of the GetNextImageProperty method is:

  char *GetNextImageProperty(const Image *image)

A description of each parameter follows:

image

the image.

InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.

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:

image_info

the image info.

image

the image.

embed_text

the address of a character string containing the embedded formatting characters.

RemoveImageProperty() removes a property from the image and returns its value.

The format of the RemoveImageProperty method is:

  char *RemoveImageProperty(Image *image,const char *property)

A description of each parameter follows:

image

the image.

property

the image property.

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:

image

the image.

SetImageProperty() associates an value with an image property.

The format of the SetImageProperty method is:

  MagickBooleanType SetImageProperty(Image *image,const char *property,
    const char *value)

A description of each parameter follows:

image

the image.

property

the image property.

values

the image property values.