1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
\r
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
\r
5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
\r
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
8 <style type="text/css" media="all">
\r
9 @import url("../../www/magick.css");
\r
11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickWand, C API for ImageMagick: Wand Methods</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <meta name="Keywords" content="magickwc, api, for, imagemagick:, wmethods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
29 <body id="www-imagemagick-org">
\r
30 <div class="titlebar">
\r
31 <a href="../../index.html">
\r
32 <img src="../../images/script.png" alt="[ImageMagick]"
\r
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
34 <a href="http://www.networkredux.com">
\r
35 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
37 <a href="http://www.imagemagick.org/discourse-server/">
\r
38 <img src="../../images/logo.jpg" alt=""
\r
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
40 <a href="../../index.html">
\r
41 <img src="../../images/sprite.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
45 <div class="eastbar">
\r
48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
63 <div class="sep"></div>
\r
65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
91 <div class="sep"></div>
\r
93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
102 <a title="Resources" href="../../www/resources.html">Resources</a>
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
108 <a title="Download" href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
129 <div class="sponsor">
130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
132 <div class="sponsor">
133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
135 <div class="sponsor">
136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
138 <div class="sponsor">
139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141 <div class="sponsor">
142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
144 <div class="sponsor">
145 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
155 <p class="navigation-index">[<a href="#ClearMagickWand">ClearMagickWand</a> • <a href="#CloneMagickWand">CloneMagickWand</a> • <a href="#DestroyMagickWand">DestroyMagickWand</a> • <a href="#IsMagickWand">IsMagickWand</a> • <a href="#MagickClearException">MagickClearException</a> • <a href="#MagickGetException">MagickGetException</a> • <a href="#MagickGetExceptionType">MagickGetExceptionType</a> • <a href="#MagickGetIteratorIndex">MagickGetIteratorIndex</a> • <a href="#MagickQueryConfigureOption">MagickQueryConfigureOption</a> • <a href="#MagickQueryConfigureOptions">MagickQueryConfigureOptions</a> • <a href="#MagickQueryFontMetrics">MagickQueryFontMetrics</a> • <a href="#MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a> • <a href="#MagickQueryFonts">MagickQueryFonts</a> • <a href="#MagickQueryFonts">MagickQueryFonts</a> • <a href="#MagickRelinquishMemory">MagickRelinquishMemory</a> • <a href="#MagickResetIterator">MagickResetIterator</a> • <a href="#MagickSetFirstIterator">MagickSetFirstIterator</a> • <a href="#MagickSetIteratorIndex">MagickSetIteratorIndex</a> • <a href="#MagickSetLastIterator">MagickSetLastIterator</a> • <a href="#MagickWandGenesis">MagickWandGenesis</a> • <a href="#MagickWandTerminus">MagickWandTerminus</a> • <a href="#NewMagickWand">NewMagickWand</a> • <a href="#NewMagickWandFromImage">NewMagickWandFromImage</a>]</p>
157 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
158 _8c.html" target="source" name="ClearMagickWand">ClearMagickWand</a></h2>
159 <div class="doc-section">
161 <p>ClearMagickWand() clears resources associated with the wand.</p></ol>
163 <p>The format of the ClearMagickWand method is:</p>
166 void ClearMagickWand(MagickWand *wand)
169 <p>A description of each parameter follows:</p></ol>
172 <ol><p>the magick wand.</p></ol>
175 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
176 _8c.html" target="source" name="CloneMagickWand">CloneMagickWand</a></h2>
177 <div class="doc-section">
179 <p>CloneMagickWand() makes an exact copy of the specified wand.</p></ol>
181 <p>The format of the CloneMagickWand method is:</p>
184 MagickWand *CloneMagickWand(const MagickWand *wand)
187 <p>A description of each parameter follows:</p></ol>
190 <ol><p>the magick wand.</p></ol>
193 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
194 _8c.html" target="source" name="DestroyMagickWand">DestroyMagickWand</a></h2>
195 <div class="doc-section">
197 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p></ol>
199 <p>The format of the DestroyMagickWand method is:</p>
202 MagickWand *DestroyMagickWand(MagickWand *wand)
205 <p>A description of each parameter follows:</p></ol>
208 <ol><p>the magick wand.</p></ol>
211 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
212 _8c.html" target="source" name="IsMagickWand">IsMagickWand</a></h2>
213 <div class="doc-section">
215 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p></ol>
217 <p>The format of the IsMagickWand method is:</p>
220 MagickBooleanType IsMagickWand(const MagickWand *wand)
223 <p>A description of each parameter follows:</p></ol>
226 <ol><p>the magick wand.</p></ol>
229 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
230 _8c.html" target="source" name="MagickClearException">MagickClearException</a></h2>
231 <div class="doc-section">
233 <p>MagickClearException() clears any exceptions associated with the wand.</p></ol>
235 <p>The format of the MagickClearException method is:</p>
238 MagickBooleanType MagickClearException(MagickWand *wand)
241 <p>A description of each parameter follows:</p></ol>
244 <ol><p>the magick wand.</p></ol>
247 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
248 _8c.html" target="source" name="MagickGetException">MagickGetException</a></h2>
249 <div class="doc-section">
251 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
253 <p>The format of the MagickGetException method is:</p>
256 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
259 <p>A description of each parameter follows:</p></ol>
262 <ol><p>the magick wand.</p></ol>
265 <ol><p>the severity of the error is returned here.</p></ol>
268 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
269 _8c.html" target="source" name="MagickGetExceptionType">MagickGetExceptionType</a></h2>
270 <div class="doc-section">
272 <p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
274 <p>The format of the MagickGetExceptionType method is:</p>
277 ExceptionType MagickGetExceptionType(const MagickWand *wand)
280 <p>A description of each parameter follows:</p></ol>
283 <ol><p>the magick wand.</p></ol>
286 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
287 _8c.html" target="source" name="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
288 <div class="doc-section">
290 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p></ol>
292 <p>The format of the MagickGetIteratorIndex method is:</p>
295 ssize_t MagickGetIteratorIndex(MagickWand *wand)
298 <p>A description of each parameter follows:</p></ol>
301 <ol><p>the magick wand.</p></ol>
304 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
305 _8c.html" target="source" name="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
306 <div class="doc-section">
308 <p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p></ol>
310 <p>The format of the MagickQueryConfigureOption function is:</p>
313 char *MagickQueryConfigureOption(const char *option)
316 <p>A description of each parameter follows:</p></ol>
319 <ol><p>the option name.</p></ol>
322 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
323 _8c.html" target="source" name="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
324 <div class="doc-section">
326 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p></ol>
328 <p>The format of the MagickQueryConfigureOptions function is:</p>
331 char **MagickQueryConfigureOptions(const char *pattern,
332 size_t *number_options)
335 <p>A description of each parameter follows:</p></ol>
338 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
340 <h5>number_options</h5>
341 <ol><p>Returns the number of configure options in the list.</p></ol>
345 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
346 _8c.html" target="source" name="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
347 <div class="doc-section">
349 <p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
353 -------------------------------------------------
360 6 maximum horizontal advance
369 <p>The format of the MagickQueryFontMetrics method is:</p>
372 double *MagickQueryFontMetrics(MagickWand *wand,
373 const DrawingWand *drawing_wand,const char *text)
376 <p>A description of each parameter follows:</p></ol>
379 <ol><p>the Magick wand.</p></ol>
381 <h5>drawing_wand</h5>
382 <ol><p>the drawing wand.</p></ol>
385 <ol><p>the text.</p></ol>
388 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
389 _8c.html" target="source" name="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
390 <div class="doc-section">
392 <p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
396 -------------------------------------------------
403 6 maximum horizontal advance
412 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
414 <p>The format of the MagickQueryFontMetrics method is:</p>
417 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
418 const DrawingWand *drawing_wand,const char *text)
421 <p>A description of each parameter follows:</p></ol>
424 <ol><p>the Magick wand.</p></ol>
426 <h5>drawing_wand</h5>
427 <ol><p>the drawing wand.</p></ol>
430 <ol><p>the text.</p></ol>
433 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
434 _8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
435 <div class="doc-section">
437 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p></ol>
439 <p>The format of the MagickQueryFonts function is:</p>
442 char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
445 <p>A description of each parameter follows:</p></ol>
448 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
450 <h5>number_fonts</h5>
451 <ol><p>Returns the number of fonts in the list.</p></ol>
455 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
456 _8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
457 <div class="doc-section">
459 <p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).</p></ol>
461 <p>The format of the MagickQueryFonts function is:</p>
464 char **MagickQueryFonts(const char *pattern,
465 size_t *number_formats)
468 <p>A description of each parameter follows:</p></ol>
471 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
473 <h5>number_formats</h5>
474 <ol><p>This integer returns the number of image formats in the list.</p></ol>
477 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
478 _8c.html" target="source" name="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
479 <div class="doc-section">
481 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p></ol>
483 <p>The format of the MagickRelinquishMemory method is:</p>
486 void *MagickRelinquishMemory(void *resource)
489 <p>A description of each parameter follows:</p></ol>
492 <ol><p>Relinquish the memory associated with this resource.</p></ol>
495 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
496 _8c.html" target="source" name="MagickResetIterator">MagickResetIterator</a></h2>
497 <div class="doc-section">
499 <p>MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p></ol>
501 <p>The format of the MagickResetIterator method is:</p>
504 void MagickResetIterator(MagickWand *wand)
507 <p>A description of each parameter follows:</p></ol>
510 <ol><p>the magick wand.</p></ol>
513 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
514 _8c.html" target="source" name="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
515 <div class="doc-section">
517 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p></ol>
519 <p>The format of the MagickSetFirstIterator method is:</p>
522 void MagickSetFirstIterator(MagickWand *wand)
525 <p>A description of each parameter follows:</p></ol>
528 <ol><p>the magick wand.</p></ol>
531 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
532 _8c.html" target="source" name="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
533 <div class="doc-section">
535 <p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p></ol>
537 <p>The format of the MagickSetIteratorIndex method is:</p>
540 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
544 <p>A description of each parameter follows:</p></ol>
547 <ol><p>the magick wand.</p></ol>
550 <ol><p>the scene number.</p></ol>
553 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
554 _8c.html" target="source" name="MagickSetLastIterator">MagickSetLastIterator</a></h2>
555 <div class="doc-section">
557 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p></ol>
559 <p>The format of the MagickSetLastIterator method is:</p>
562 void MagickSetLastIterator(MagickWand *wand)
565 <p>A description of each parameter follows:</p></ol>
568 <ol><p>the magick wand.</p></ol>
571 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
572 _8c.html" target="source" name="MagickWandGenesis">MagickWandGenesis</a></h2>
573 <div class="doc-section">
575 <p>MagickWandGenesis() initializes the MagickWand environment.</p></ol>
577 <p>The format of the MagickWandGenesis method is:</p>
580 void MagickWandGenesis(void)
584 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
585 _8c.html" target="source" name="MagickWandTerminus">MagickWandTerminus</a></h2>
586 <div class="doc-section">
588 <p>MagickWandTerminus() terminates the MagickWand environment.</p></ol>
590 <p>The format of the MaickWandTerminus method is:</p>
593 void MagickWandTerminus(void)
597 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
598 _8c.html" target="source" name="NewMagickWand">NewMagickWand</a></h2>
599 <div class="doc-section">
601 <p>NewMagickWand() returns a wand required for all other methods in the API.</p></ol>
603 <p>The format of the NewMagickWand method is:</p>
606 MagickWand *NewMagickWand(void)
610 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
611 _8c.html" target="source" name="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
612 <div class="doc-section">
614 <p>NewMagickWandFromImage() returns a wand with an image.</p></ol>
616 <p>The format of the NewMagickWandFromImage method is:</p>
619 MagickWand *NewMagickWandFromImage(const Image *image)
622 <p>A description of each parameter follows:</p></ol>
625 <ol><p>the image.</p></ol>
632 <!-- <span id="linkbar-west"> </span> -->
\r
633 <span id="linkbar-center">
\r
634 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
635 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
637 <span id="linkbar-east"> </span>
\r
639 <div class="footer">
\r
640 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
641 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
643 <div style="clear: both; margin: 0; width: 100%; "></div>
\r