ImageMagick: MagickWand, C API for ImageMagick: Wand Methods

Unix
Mac OS X
Windows
Processing
Options
Usage
MagickWand
MagickCore
PerlMagick
Magick++
Unix
Windows
Links

## ClearMagickWand

ClearMagickWand() clears resources associated with the wand.

The format of the ClearMagickWand method is:

      void ClearMagickWand(MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## CloneMagickWand

CloneMagickWand() makes an exact copy of the specified wand.

The format of the CloneMagickWand method is:

      MagickWand *CloneMagickWand(const MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## DestroyMagickWand

DestroyMagickWand() deallocates memory associated with an MagickWand.

The format of the DestroyMagickWand method is:

      MagickWand *DestroyMagickWand(MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## IsMagickWand

IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.

The format of the IsMagickWand method is:

      MagickBooleanType IsMagickWand(const MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## MagickClearException

MagickClearException() clears any exceptions associated with the wand.

The format of the MagickClearException method is:

      MagickBooleanType MagickClearException(MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## MagickGetException

MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.

The format of the MagickGetException method is:

      char *MagickGetException(const MagickWand *wand,ExceptionType *severity)

A description of each parameter follows:

##### wand

the magick wand.

##### severity

the severity of the error is returned here.

## MagickGetExceptionType

MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.

The format of the MagickGetExceptionType method is:

      ExceptionType MagickGetExceptionType(const MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## MagickGetIteratorIndex

MagickGetIteratorIndex() returns the position of the iterator in the image list.

The format of the MagickGetIteratorIndex method is:

      ssize_t MagickGetIteratorIndex(MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## MagickQueryConfigureOption

MagickQueryConfigureOption() returns the value associated with the specified configure option.

The format of the MagickQueryConfigureOption function is:

      char *MagickQueryConfigureOption(const char *option)

A description of each parameter follows:

##### option

the option name.

## MagickQueryConfigureOptions

MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.

The format of the MagickQueryConfigureOptions function is:

      char **MagickQueryConfigureOptions(const char *pattern,
        size_t *number_options)

A description of each parameter follows:

##### pattern

Specifies a pointer to a text string containing a pattern.

##### number_options

Returns the number of configure options in the list.

## MagickQueryFontMetrics

MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:

          Element Description
          -------------------------------------------------
          0 character width
          1 character height
          2 ascender
          3 descender
          4 text width
          5 text height
          6 maximum horizontal advance
          7 bounding box: x1
          8 bounding box: y1
          9 bounding box: x2
         10 bounding box: y2
         11 origin: x
         12 origin: y

The format of the MagickQueryFontMetrics method is:

      double *MagickQueryFontMetrics(MagickWand *wand,
        const DrawingWand *drawing_wand,const char *text)

A description of each parameter follows:

##### wand

the Magick wand.

##### drawing_wand

the drawing wand.

##### text

the text.

## MagickQueryMultilineFontMetrics

MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:

          Element Description
          -------------------------------------------------
          0 character width
          1 character height
          2 ascender
          3 descender
          4 text width
          5 text height
          6 maximum horizontal advance
          7 bounding box: x1
          8 bounding box: y1
          9 bounding box: x2
         10 bounding box: y2
         11 origin: x
         12 origin: y

This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.

The format of the MagickQueryFontMetrics method is:

      double *MagickQueryMultilineFontMetrics(MagickWand *wand,
        const DrawingWand *drawing_wand,const char *text)

A description of each parameter follows:

##### wand

the Magick wand.

##### drawing_wand

the drawing wand.

##### text

the text.

## MagickQueryFonts

MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).

The format of the MagickQueryFonts function is:

      char **MagickQueryFonts(const char *pattern,size_t *number_fonts)

A description of each parameter follows:

##### pattern

Specifies a pointer to a text string containing a pattern.

##### number_fonts

Returns the number of fonts in the list.

## MagickQueryFonts

MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).

The format of the MagickQueryFonts function is:

      char **MagickQueryFonts(const char *pattern,
        size_t *number_formats)

A description of each parameter follows:

##### pattern

Specifies a pointer to a text string containing a pattern.

##### number_formats

This integer returns the number of image formats in the list.

## MagickRelinquishMemory

MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.

The format of the MagickRelinquishMemory method is:

      void *MagickRelinquishMemory(void *resource)

A description of each parameter follows:

##### resource

Relinquish the memory associated with this resource.

## MagickResetIterator

MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.

The format of the MagickResetIterator method is:

      void MagickResetIterator(MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## MagickSetFirstIterator

MagickSetFirstIterator() sets the wand iterator to the first image.

The format of the MagickSetFirstIterator method is:

      void MagickSetFirstIterator(MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## MagickSetIteratorIndex

MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.

The format of the MagickSetIteratorIndex method is:

      MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
        const ssize_t index)

A description of each parameter follows:

##### wand

the magick wand.

##### index

the scene number.

## MagickSetLastIterator

MagickSetLastIterator() sets the wand iterator to the last image.

The format of the MagickSetLastIterator method is:

      void MagickSetLastIterator(MagickWand *wand)

A description of each parameter follows:

##### wand

the magick wand.

## MagickWandGenesis

MagickWandGenesis() initializes the MagickWand environment.

The format of the MagickWandGenesis method is:

      void MagickWandGenesis(void)

## MagickWandTerminus

MagickWandTerminus() terminates the MagickWand environment.

The format of the MaickWandTerminus method is:

      void MagickWandTerminus(void)

## NewMagickWand

NewMagickWand() returns a wand required for all other methods in the API.

The format of the NewMagickWand method is:

      MagickWand *NewMagickWand(void)

## NewMagickWandFromImage

NewMagickWandFromImage() returns a wand with an image.

The format of the NewMagickWandFromImage method is:

      MagickWand *NewMagickWandFromImage(const Image *image)

A description of each parameter follows:

##### image

the image.

Discourse Server • Studio