1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>magick - Read or List Image formats</title>
<link rel="stylesheet" type="text/css" href="../magick.css">
</head>
<body marginheight="1" marginwidth="1" topmargin="1" leftmargin="1">
<a name="top"></a>
<table border="0" cellpadding="0" cellspacing="0" summary="Masthead" width="100%">
<tbody>
<tr>
<td bgcolor="#003399" width="25%" height="118" background="../../images/background.gif"><a href="http://www.imagemagick.org/"><img src="../../images/script.gif" width="278" height="118" border="0" alt="" /></a></td>
<td bgcolor="#003399" width="60%" height="118" background="../../images/background.gif"><a href="http://www.networkeleven.com/direct.php?magick_all"><img src="../../images/promote.png" border="0" width="186" height="52" vspace="29" alt="Powered by NetworkEleven" /></a></td>
<td bgcolor="#003399" width="114" height="118" align="right"><img src="../../images/sprite.png" width="114" height="118" alt="" /></td>
<td bgcolor="#003399" width="114" height="118" align="right"><a href="http://www.imagemagick.net"><img src="../../images/logo.png" width="114" height="118" border="0" alt="ImageMagick logo" /></a></td>
</tr></tbody></table>
<table align="left" border="0" cellpadding="2" cellspacing="2" summary="Navigation buttons" width="20%">
<tr>
<td>
<form target="_self" action="../../index.html"><input type="submit" title="ImageMagick Home" value=" Home" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/apis.html"><input type="submit" title="ImageMagick API" value=" API " style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/archives.html"><input type="submit" title="ImageMagick Download" value="Download" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td></tr></table>
<div align="right" style="margin-top:3px; padding-right:4px">
<form action="http://studio.imagemagick.org/Sage/scripts/Sage.cgi"><input type="TEXT" name="query" size="32" maxlength="255"> <input type="SUBMIT" name="sa" value="Search" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); bgcolor:#003399; color:#fbc713; font-weight:bold"></form></div>
<table align="left" border="0" cellpadding="10" cellspacing="0" style="margin-top:-17px" width="100%">
<tr>
<td>
<P><a name="__index__"></a></P>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li>
<ul>
<li><a href="#destroymagick">DestroyMagick</a></li>
<li><a href="#destroymagicklist">DestroyMagickList</a></li>
<li><a href="#getimagemagick">GetImageMagick</a></li>
<li><a href="#getmagickadjoin">GetMagickAdjoin</a></li>
<li><a href="#getmagickblobsupport">GetMagickBlobSupport</a></li>
<li><a href="#getmagickdecoder">GetMagickDecoder</a></li>
<li><a href="#getmagickdescription">GetMagickDescription</a></li>
<li><a href="#getmagickencoder">GetMagickEncoder</a></li>
<li><a href="#getmagickendiansupport">GetMagickEndianSupport</a></li>
<li><a href="#getmagickinfo">GetMagickInfo</a></li>
<li><a href="#getmagickinfolist">GetMagickInfoList</a></li>
<li><a href="#getmagicklist">GetMagickList</a></li>
<li><a href="#getmagickseekablestream">GetMagickSeekableStream</a></li>
<li><a href="#getmagickthreadsupport">GetMagickThreadSupport</a></li>
<li><a href="#initializemagick">InitializeMagick</a></li>
<li><a href="#ismagickconflict">IsMagickConflict</a></li>
<li><a href="#listmagickinfo">ListMagickInfo</a></li>
<li><a href="#ismagickinstantiated">IsMagickInstantiated</a></li>
<li><a href="#magicktomime">MagickToMime</a></li>
<li><a href="#registermagickinfo">RegisterMagickInfo</a></li>
<li><a href="#setmagickinfo">SetMagickInfo</a></li>
<li><a href="#unregistermagickinfo">UnregisterMagickInfo</a></li>
</ul>
</ul>
<!-- INDEX END -->
<hr />
<P>
</P>
<h1><a name="name">NAME</a></h1>
<P>magick - Read or List Image formats</P>
<P>
</P>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<P><strong>DestroyMagick</strong>( void );</P>
<P>void <strong>DestroyMagickList</strong>( void );</P>
<P>const char * <strong>GetImageMagick</strong>( const unsigned char *magick, const size_t length );</P>
<P>MagickBooleanType <strong>GetMagickAdjoin</strong>( const MagickInfo *magick_info );</P>
<P>MagickBooleanType <strong>GetMagickBlobSupport</strong>( const MagickInfo *magick_info );</P>
<P>DecoderHandler * <strong>GetMagickDecoder</strong>( const MagickInfo *magick_info );</P>
<P>const char * <strong>GetMagickDescription</strong>( const MagickInfo *magick_info );</P>
<P>EncoderHandler * <strong>GetMagickEncoder</strong>( const MagickInfo *magick_info );</P>
<P>EndianType <strong>GetMagickEndianSupport</strong>( const MagickInfo *magick_info );</P>
<P>const MagickInfo * <strong>GetMagickInfo</strong>( const char *name, Exception *exception );</P>
<P>const MagickInfo ** <strong>GetMagickInfoList</strong>( const char *pattern, unsigned long *number_formats );</P>
<P>char ** <strong>GetMagickList</strong>( const char *pattern, unsigned long *number_formats );</P>
<P>MagickBooleanType <strong>GetMagickSeekableStream</strong>( const MagickInfo *magick_info );</P>
<P>MagickBooleanType <strong>GetMagickThreadSupport</strong>( const MagickInfo *magick_info );</P>
<P><strong>InitializeMagick</strong>( const char *path );</P>
<P>MagickBooleanType <strong>IsMagickConflict</strong>( const char *magick );</P>
<P>MagickBooleanType <strong>IsMagickInstantiated</strong>( void );</P>
<P>MagickBooleanType <strong>ListMagickInfo</strong>( FILE *file, ExceptionInfo *exception );</P>
<P>char * <strong>MagickToMime</strong>( const char *magick );</P>
<P>MagickInfo * <strong>RegisterMagickInfo</strong>( MagickInfo *magick_info );</P>
<P>MagickInfo * <strong>SetMagickInfo</strong>( const char *name );</P>
<P>MagickBooleanType <strong>UnregisterMagickInfo</strong>( const char *name );</P>
<P>
</P>
<hr />
<h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1>
<P>
</P>
<h2><a name="destroymagick">DestroyMagick</a></h2>
<blockquote>DestroyMagick() destroys the ImageMagick environment. </blockquote><P>The format of the DestroyMagick function is:</P>
<blockquote>DestroyMagick ( void ); </blockquote><P>
</P>
<h2><a name="destroymagicklist">DestroyMagickList</a></h2>
<blockquote>DestroyMagickList() deallocates memory associated <A HREF="types.html#MagickInfo">MagickInfo</A> list. </blockquote><P>The format of the DestroyMagickList method is:</P>
<blockquote>void DestroyMagickList ( void ); </blockquote><P>
</P>
<h2><a name="getimagemagick">GetImageMagick</a></h2>
<blockquote>GetImageMagick() searches for an image format that matches the specified magick string. If one is found the name is returned otherwise NULL. </blockquote><P>The format of the GetImageMagick method is:</P>
<blockquote>const char *GetImageMagick ( const unsigned char *magick, const size_t length ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_magick_3a">magick:</a></strong><br />
</dt>
<DD>
The image format we are searching for.
</dd>
<P></P>
<dt><strong><a name="item_o_length_3a">length:</a></strong><br />
</dt>
<DD>
The length of the binary string.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickadjoin">GetMagickAdjoin</a></h2>
<blockquote>GetMagickAdjoin() returns MagickTrue if the magick adjoin is MagickTrue. </blockquote><P>The format of the GetMagickAdjoin method is:</P>
<blockquote>MagickBooleanType GetMagickAdjoin ( const <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_magick_info_3a">magick_info:</a></strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickblobsupport">GetMagickBlobSupport</a></h2>
<blockquote>GetMagickBlobSupport() returns MagickTrue if the magick supports blobs. </blockquote><P>The format of the GetMagickBlobSupport method is:</P>
<blockquote>MagickBooleanType GetMagickBlobSupport ( const <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickdecoder">GetMagickDecoder</a></h2>
<blockquote>GetMagickDecoder() returns the magick decoder. </blockquote><P>The format of the GetMagickDecoder method is:</P>
<blockquote>DecoderHandler *GetMagickDecoder ( const <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickdescription">GetMagickDescription</a></h2>
<blockquote>GetMagickDescription() returns the magick description. </blockquote><P>The format of the GetMagickDescription method is:</P>
<blockquote>const char *GetMagickDescription ( const <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickencoder">GetMagickEncoder</a></h2>
<blockquote>GetMagickEncoder() returns the magick encoder. </blockquote><P>The format of the GetMagickEncoder method is:</P>
<blockquote>EncoderHandler *GetMagickEncoder ( const <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickendiansupport">GetMagickEndianSupport</a></h2>
<blockquote>GetMagickEndianSupport() returns the MagickTrue if the coder respects endianess other than MSBEndian. </blockquote><P>The format of the GetMagickEndianSupport method is:</P>
<blockquote>EndianType GetMagickEndianSupport ( const <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickinfo">GetMagickInfo</a></h2>
<blockquote>GetMagickInfo() returns a pointer <A HREF="types.html#MagickInfo">MagickInfo</A> structure that matches the specified name. If name is NULL, the head of the image format list is returned. </blockquote><P>The format of the GetMagickInfo method is:</P>
<blockquote>const <A HREF="types.html#MagickInfo">MagickInfo</A> *GetMagickInfo ( const char *name, Exception *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_name_3a">name:</a></strong><br />
</dt>
<DD>
The image format we are looking for.
</dd>
<P></P>
<dt><strong><a name="item_o_exception_3a">exception:</a></strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickinfolist">GetMagickInfoList</a></h2>
<blockquote>GetMagickInfoList() returns any image formats that match the specified pattern. </blockquote><P>The format of the GetMagickInfoList function is:</P>
<blockquote>const <A HREF="types.html#MagickInfo">MagickInfo</A> **GetMagickInfoList ( const char *pattern, unsigned long *number_formats ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_pattern_3a">pattern:</a></strong><br />
</dt>
<DD>
Specifies a pointer to a text string containing a pattern.
</dd>
<P></P>
<dt><strong><a name="item_o_number_formats_3a">number_formats:</a></strong><br />
</dt>
<DD>
This integer returns the number of formats in the list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagicklist">GetMagickList</a></h2>
<blockquote>GetMagickList() returns any image formats that match the specified pattern. </blockquote><P>The format of the GetMagickList function is:</P>
<blockquote>char **GetMagickList ( const char *pattern, unsigned long *number_formats ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>pattern:</strong><br />
</dt>
<DD>
Specifies a pointer to a text string containing a pattern.
</dd>
<P></P>
<dt><strong>number_formats:</strong><br />
</dt>
<DD>
This integer returns the number of formats in the list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickseekablestream">GetMagickSeekableStream</a></h2>
<blockquote>GetMagickSeekableStream() returns MagickTrue if the magick supports a seekable stream. </blockquote><P>The format of the GetMagickSeekableStream method is:</P>
<blockquote>MagickBooleanType GetMagickSeekableStream ( const <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getmagickthreadsupport">GetMagickThreadSupport</a></h2>
<blockquote>GetMagickThreadSupport() returns MagickTrue if the magick supports threads. </blockquote><P>The format of the GetMagickThreadSupport method is:</P>
<blockquote>MagickBooleanType GetMagickThreadSupport ( const <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="initializemagick">InitializeMagick</a></h2>
<blockquote>InitializeMagick() initializes the ImageMagick environment. </blockquote><P>The format of the InitializeMagick function is:</P>
<blockquote>InitializeMagick ( const char *path ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_path_3a">path:</a></strong><br />
</dt>
<DD>
The execution path of the current ImageMagick client.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="ismagickconflict">IsMagickConflict</a></h2>
<blockquote>IsMagickConflict() returns true if the image format is not a valid image format or conflicts with a logical drive ( .e.g. X: ) . </blockquote><P>The format of the IsMagickConflict method is:</P>
<blockquote>MagickBooleanType IsMagickConflict ( const char *magick ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_status_3a">status:</a></strong><br />
</dt>
<DD>
Method IsMagickConflict returns true if the image format conflicts with a logical drive.
</dd>
<P></P>
<dt><strong>magick:</strong><br />
</dt>
<DD>
Specifies the image format.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="listmagickinfo">ListMagickInfo</a></h2>
<blockquote>ListMagickInfo() lists the image formats to a file. </blockquote><P>The format of the ListMagickInfo method is:</P>
<blockquote>MagickBooleanType ListMagickInfo ( FILE *file, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows.</P>
<dl>
<dt><strong><a name="item_o_file_3a">file:</a></strong><br />
</dt>
<DD>
A file handle.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="ismagickinstantiated">IsMagickInstantiated</a></h2>
<blockquote>IsMagickInstantiated() returns MagickTrue if the ImageMagick environment is currently instantiated: InitializeMagick ( ) has been called but MagickDestroy ( ) has not. </blockquote><P>The format of the IsMagickInstantiated method is:</P>
<blockquote>MagickBooleanType IsMagickInstantiated ( void ); </blockquote><P>
</P>
<h2><a name="magicktomime">MagickToMime</a></h2>
<blockquote>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. </blockquote><P>The format of the MagickToMime method is:</P>
<blockquote>char *MagickToMime ( const char *magick ); </blockquote><P>A description of each parameter follows.</P>
<dl>
<dt><strong>magick:</strong><br />
</dt>
<DD>
ImageMagick format specification ``magick'' tag.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="registermagickinfo">RegisterMagickInfo</a></h2>
<blockquote>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. </blockquote><P>The format of the RegisterMagickInfo method is:</P>
<blockquote><A HREF="types.html#MagickInfo">MagickInfo</A> *RegisterMagickInfo ( <A HREF="types.html#MagickInfo">MagickInfo</A> *magick_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
The magick info.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="setmagickinfo">SetMagickInfo</a></h2>
<blockquote>SetMagickInfo() allocates a <A HREF="types.html#MagickInfo">MagickInfo</A> structure and initializes the members to default values. </blockquote><P>The format of the SetMagickInfo method is:</P>
<blockquote><A HREF="types.html#MagickInfo">MagickInfo</A> *SetMagickInfo ( const char *name ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>magick_info:</strong><br />
</dt>
<DD>
Method SetMagickInfo returns the allocated and initialized MagickInfo structure.
</dd>
<P></P>
<dt><strong>name:</strong><br />
</dt>
<DD>
a character string that represents the image format associated with the MagickInfo structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="unregistermagickinfo">UnregisterMagickInfo</a></h2>
<blockquote>UnregisterMagickInfo() removes a name from the magick info list. It returns MagickFalse if the name does not exist in the list otherwise MagickTrue. </blockquote><P>The format of the UnregisterMagickInfo method is:</P>
<blockquote>MagickBooleanType UnregisterMagickInfo ( const char *name ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>name:</strong><br />
</dt>
<DD>
a character string that represents the image format we are looking for.
</dd>
</dl>
<HR>
<a href="#top"><img src="../../../images/top.gif" border=0 width=42 height=42 align="right" alt="Top of page"></a>
<form action="http://studio.imagemagick.org/magick/" style="margin-top:5px">
<input type="submit" title="Help!" value="Help!" style="background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold">
<small>"Image manipulation software that works like magick"</small>
</form></td>
</tr></table>
</body>
</html>
|
