magick - Methods to Read or List ImageMagick Image formats

- NAME
- SYNOPSIS
- FUNCTION DESCRIPTIONS

- DestroyMagick
- DestroyMagickInfo
- GetImageMagick
- GetMagickConfigurePath
- GetMagickInfo
- GetMagickVersion
- InitializeMagick
- IsMagickConflict
- ListMagickInfo
- RegisterMagickInfo
- SetMagickInfo
- UnregisterMagickInfo

# NAME

magick - Methods to Read or List ImageMagick Image formats

# SYNOPSIS

DestroyMagick( void );

void DestroyMagickInfo( void );

char * GetImageMagick( const unsigned char *magick, const unsigned int length );

char * GetMagickConfigurePath( const char *filename );

MagickInfo * GetMagickInfo( const char *name, Exception *exception );

char * GetMagickVersion( unsigned int *version );

InitializeMagick( const char *path );

unsigned int IsMagickConflict( const char *magick );

unsigned int ListMagickInfo( FILE *file, ExceptionInfo *exception );

MagickInfo * RegisterMagickInfo( MagickInfo *magick_info );

MagickInfo * SetMagickInfo( const char *name );

unsigned int UnregisterMagickInfo( const char *name );

# FUNCTION DESCRIPTIONS

## DestroyMagick

Method InitializeMagick destroys the ImageMagick environment.

The format of the DestroyMagick function is:

> DestroyMagick ( void );

## DestroyMagickInfo

Method DestroyMagickInfo deallocates memory associated MagickInfo list.

The format of the DestroyMagickInfo method is:

> void DestroyMagickInfo ( void );

## GetImageMagick

Method GetImageMagick searches for an image format that matches the specified magick string. If one is found the name is returned otherwise NULL.

The format of the GetImageMagick method is:

> char *GetImageMagick ( const unsigned char *magick, const unsigned int length );

A description of each parameter follows:

name:
  Method GetImageMagick returns a name that matches the specified magick string.

magick:
  a character string that represents the image format we are looking for.

length:
  The length of the binary string.

## GetMagickConfigurePath

Method GetMagickConfigurePath searches a number of pre-defined locations for the specified ImageMagick configuration file and returns the path. The search order follows:

               <current directory>/
               <client path>/
               $MAGICK_HOME/
               $HOME/.magick/
               MagickLibPath
               MagickModulesPath
               MagickSharePath

The format of the GetMagickConfigurePath method is:

> char *GetMagickConfigurePath ( const char *filename );

A description of each parameter follows:

path:
  Method GetMagickConfigurePath returns the path if the configuration file is found, otherwise NULL is returned.

filename:
  A character string representing the desired configuration file.

## GetMagickInfo

Method GetMagickInfo returns a pointer MagickInfo structure that matches the specified name. If name is NULL, the head of the image format list is returned.

The format of the GetMagickInfo method is:

> MagickInfo *GetMagickInfo ( const char *name, Exception *exception );

A description of each parameter follows:

magick_info:
  Method GetMagickInfo returns a pointer MagickInfo structure that matches the specified name.

name:
  a character string that represents the image format we are looking for.

exception:
  Return any errors or warnings in this structure.

## GetMagickVersion

Method GetMagickVersion returns the ImageMagick API version as a string and as a number.

The format of the GetMagickVersion method is:

> char *GetMagickVersion ( unsigned int *version );

A description of each parameter follows:

string:
  Method GetMagickVersion returns the ImageMagick version string.

version:
  The ImageMagick version is returned as a number.

## InitializeMagick

Method InitializeMagick initializes the ImageMagick environment.

The format of the InitializeMagick function is:

> InitializeMagick ( const char *path );

A description of each parameter follows:

path:
  Specifies a pointer to the execution path of the current ImageMagick client.

## IsMagickConflict

Method IsMagickConflict returns true if the image format conflicts with a logical drive (.e.g. X:).

The format of the IsMagickConflict method is:

> unsigned int IsMagickConflict ( const char *magick );

A description of each parameter follows:

status:
  Method IsMagickConflict returns true if the image format conflicts with a logical drive.

magick:
  Specifies the image format.

## ListMagickInfo

Method ListMagickInfo lists the image formats to a file.

The format of the ListMagickInfo method is:

> unsigned int ListMagickInfo ( FILE *file, ExceptionInfo *exception );

A description of each parameter follows.

file:
  A pointer to a FILE structure.

exception:
  Return any errors or warnings in this structure.

## RegisterMagickInfo

Method RegisterMagickInfo adds attributes for a particular image format to the list of supported formats. The attributes include the image format name, a method to read and/or write the format, whether the format supports the saving of more than one frame to the same file or blob, whether the format supports native in-memory I/O, and a brief description of the format.

The format of the RegisterMagickInfo method is:

> MagickInfo *RegisterMagickInfo ( MagickInfo *magick_info );

A description of each parameter follows:

magick_info:
  Method RegisterMagickInfo returns a pointer MagickInfo structure that contains the specified name info.

magick_info:
  A pointer to a structure of type MagickInfo.

## SetMagickInfo

Method SetMagickInfo allocates a MagickInfo structure and initializes the members to default values.

The format of the SetMagickInfo method is:

> MagickInfo *SetMagickInfo ( const char *name );

A description of each parameter follows:

magick_info:
  Method SetMagickInfo returns the allocated and initialized MagickInfo structure.

name:
  a character string that represents the image format associated with the MagickInfo structure.

## UnregisterMagickInfo

Method UnregisterMagickInfo removes a name from the magick info list. It returns False if the name does not exist in the list otherwise True.

The format of the UnregisterMagickInfo method is:

> unsigned int UnregisterMagickInfo ( const char *name );

A description of each parameter follows:

status:
  Method UnregisterMagickInfo returns False if the name does not exist in the list otherwise True.

name:
  a character string that represents the image format we are looking for.