m+IImagick - Methods to Read or List ImageMagick Image formats>j Pair








NAME

A

magick - Methods to Read or List ImageMagick Image formats






(

SYNOPSIS

.

DestroyMagick( void );

8

void DestroyMagickInfo( void );

h

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

c

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

=

InitializeMagick( const char *path );

M

unsigned int IsMagickConflict( const char *magick );

]

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

B

char * MagickToMime( const char *magick );

S

MagickInfo * RegisterMagickInfo( MagickInfo *magick_info );

G

MagickInfo * SetMagickInfo( const char *name );

O

unsigned int UnregisterMagickInfo( const char *name );






B

FUNCTION DESCRIPTIONS





2

DestroyMagick

DestroyMagick() destroys the ImageMagick environment.

The format of the DestroyMagick function is:

4
DestroyMagick ( void );



:

DestroyMagickInfo

µ
DestroyMagickInfo() deallocates memory associated MagickInfo list.

The format of the DestroyMagickInfo method is:

=
void DestroyMagickInfo ( void );



4

GetImageMagick

Ø
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:

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

A description of each parameter follows:


C
o magick:


&The image format we are searching for.


C
o length:


The length of the binary string.





2

GetMagickInfo


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:

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

A description of each parameter follows:


?
o name:


$The image format we are looking for.


I
o exception:


0Return any errors or warnings in this structure.





8

InitializeMagick

InitializeMagick() initializes the ImageMagick environment.

The format of the InitializeMagick function is:

o
InitializeMagick ( const char *path );

A description of each parameter follows:


?
o path:


5The execution path of the current ImageMagick client.





8

IsMagickConflict

k

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

4

The format of the IsMagickConflict method is:

~
unsigned int IsMagickConflict ( const char *magick );

A description of each parameter follows:


C
o status:


XMethod IsMagickConflict returns true if the image format conflicts with a logical drive.


$
o magick:


Specifies the image format.





4

ListMagickInfo


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.


?
o file:


A file handle.


'
o exception:


0Return any errors or warnings in this structure.





0

MagickToMime



Method MagickToMime returns the officially registered (or de facto) MIME media-type corresponding to a magick string. If there is no registered media-type, then the string ``image/x-magick'' (all lower case) is returned. The returned string must be deallocated by the user.

0

The format of the MagickToMime method is:

s
char *MagickToMime ( const char *magick );

A description of each parameter follows.


$
o magick:


0ImageMagick format specification ``magick'' tag.





<

RegisterMagickInfo

½
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:


M
o magick_info:


The magick info.





2

SetMagickInfo

k

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

1

The format of the SetMagickInfo method is:

œ
MagickInfo *SetMagickInfo ( const char *name );

A description of each parameter follows:


)
o magick_info:


PMethod SetMagickInfo returns the allocated and initialized MagickInfo structure.


"
o 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.

8

The format of the UnregisterMagickInfo method is:

unsigned int UnregisterMagickInfo ( const char *name );

A description of each parameter follows:


$
o status:


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


"
o name:


Ga character string that represents the image format we are looking for.