blob: 90920f56d447166c3ddab0e87369c976a1f58b37 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickWand, C API for ImageMagick: Wand Methods</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +000012 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +000016 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000024 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000027 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000028 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +000031 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000032 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000044</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000053 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000054<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000055 <img src="../../images/logo.jpg"
56 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000057 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000058<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +000059 <img src="../../images/sprite.jpg"
60 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000061 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
62</div>
63
cristyce69bb02010-07-27 19:49:46 +000064<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000065
cristy3ed852e2009-09-05 21:47:34 +000066<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000067 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000068</div>
cristy3eaa0ef2010-03-06 20:35:26 +000069<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000070<div class="menu">
cristybb503372010-05-27 20:51:26 +000071 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
78</div>
79<div class="sub">
80 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
81</div>
82<div class="sep"></div>
83<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
107<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000108 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000118 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000119 </div>
120<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000121 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000122</div>
cristybb503372010-05-27 20:51:26 +0000123<div class="menu">
124 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
125</div>
cristy3ed852e2009-09-05 21:47:34 +0000126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000129<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000130<div class="menu">
cristy52923442011-01-15 22:54:31 +0000131 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000134<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000135 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000136</div>
137<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000138 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000143
144<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000145<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000146 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
147</div>
148<div class="sponsor">
149 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
150</div>
151<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000152 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000154<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000155 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy73fd1cd2010-09-12 19:14:25 +0000156</div>
157<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000158 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
159</div>
160<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000161 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
162</div>
cristyec6b4752011-01-08 03:16:23 +0000163<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000164 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
165</div>
166<div class="sponsor">
cristyc7a6e3e2011-01-26 16:54:03 +0000167 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000168</div>
cristy96e13132010-06-07 14:55:44 +0000169</div>
cristy3ed852e2009-09-05 21:47:34 +0000170</div>
cristyce69bb02010-07-27 19:49:46 +0000171</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000172
cristyce69bb02010-07-27 19:49:46 +0000173<div class="eastbar">
174 <script type="text/javascript">
175 <!--
176 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000177 google_ad_slot = "0574824969";
178 google_ad_width = 160;
179 google_ad_height = 600;
180 //-->
181 </script>
182 <script type="text/javascript"
183 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
184 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000185</div>
186
187<div class="main">
188
cristy307ba182010-12-25 01:00:34 +0000189<h1>Module magick-wand
190 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000191<p class="navigation-index">[<a href="#ClearMagickWand">ClearMagickWand</a> &bull; <a href="#CloneMagickWand">CloneMagickWand</a> &bull; <a href="#DestroyMagickWand">DestroyMagickWand</a> &bull; <a href="#IsMagickWand">IsMagickWand</a> &bull; <a href="#MagickClearException">MagickClearException</a> &bull; <a href="#MagickGetException">MagickGetException</a> &bull; <a href="#MagickGetExceptionType">MagickGetExceptionType</a> &bull; <a href="#MagickGetIteratorIndex">MagickGetIteratorIndex</a> &bull; <a href="#MagickQueryConfigureOption">MagickQueryConfigureOption</a> &bull; <a href="#MagickQueryConfigureOptions">MagickQueryConfigureOptions</a> &bull; <a href="#MagickQueryFontMetrics">MagickQueryFontMetrics</a> &bull; <a href="#MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a> &bull; <a href="#MagickQueryFonts">MagickQueryFonts</a> &bull; <a href="#MagickQueryFonts">MagickQueryFonts</a> &bull; <a href="#MagickRelinquishMemory">MagickRelinquishMemory</a> &bull; <a href="#MagickResetIterator">MagickResetIterator</a> &bull; <a href="#MagickSetFirstIterator">MagickSetFirstIterator</a> &bull; <a href="#MagickSetIteratorIndex">MagickSetIteratorIndex</a> &bull; <a href="#MagickSetLastIterator">MagickSetLastIterator</a> &bull; <a href="#MagickWandGenesis">MagickWandGenesis</a> &bull; <a href="#MagickWandTerminus">MagickWandTerminus</a> &bull; <a href="#NewMagickWand">NewMagickWand</a> &bull; <a href="#NewMagickWandFromImage">NewMagickWandFromImage</a>]</p>
192
cristy7a40ba82011-01-08 20:31:18 +0000193<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
194_8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000195<div class="doc-section">
196
cristy7a40ba82011-01-08 20:31:18 +0000197<p>ClearMagickWand() clears resources associated with the wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000198
199<p>The format of the ClearMagickWand method is:</p>
200
201<pre class="code">
202 void ClearMagickWand(MagickWand *wand)
203</pre>
204
cristy7a40ba82011-01-08 20:31:18 +0000205<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000206
207<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000208<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000209
210 </div>
cristy7a40ba82011-01-08 20:31:18 +0000211<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
212_8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000213<div class="doc-section">
214
cristy7a40ba82011-01-08 20:31:18 +0000215<p>CloneMagickWand() makes an exact copy of the specified wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000216
217<p>The format of the CloneMagickWand method is:</p>
218
219<pre class="code">
220 MagickWand *CloneMagickWand(const MagickWand *wand)
221</pre>
222
cristy7a40ba82011-01-08 20:31:18 +0000223<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000224
225<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000226<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000227
228 </div>
cristy7a40ba82011-01-08 20:31:18 +0000229<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
230_8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000231<div class="doc-section">
232
cristy7a40ba82011-01-08 20:31:18 +0000233<p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000234
235<p>The format of the DestroyMagickWand method is:</p>
236
237<pre class="code">
238 MagickWand *DestroyMagickWand(MagickWand *wand)
239</pre>
240
cristy7a40ba82011-01-08 20:31:18 +0000241<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000242
243<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000244<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000245
246 </div>
cristy7a40ba82011-01-08 20:31:18 +0000247<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
248_8c.html" id="IsMagickWand">IsMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000249<div class="doc-section">
250
cristy7a40ba82011-01-08 20:31:18 +0000251<p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000252
253<p>The format of the IsMagickWand method is:</p>
254
255<pre class="code">
256 MagickBooleanType IsMagickWand(const MagickWand *wand)
257</pre>
258
cristy7a40ba82011-01-08 20:31:18 +0000259<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000260
261<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000262<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000263
264 </div>
cristy7a40ba82011-01-08 20:31:18 +0000265<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
266_8c.html" id="MagickClearException">MagickClearException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000267<div class="doc-section">
268
cristy7a40ba82011-01-08 20:31:18 +0000269<p>MagickClearException() clears any exceptions associated with the wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000270
271<p>The format of the MagickClearException method is:</p>
272
273<pre class="code">
274 MagickBooleanType MagickClearException(MagickWand *wand)
275</pre>
276
cristy7a40ba82011-01-08 20:31:18 +0000277<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000278
279<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000280<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000281
282 </div>
cristy7a40ba82011-01-08 20:31:18 +0000283<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
284_8c.html" id="MagickGetException">MagickGetException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000285<div class="doc-section">
286
cristy7a40ba82011-01-08 20:31:18 +0000287<p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
cristy3ed852e2009-09-05 21:47:34 +0000288
289<p>The format of the MagickGetException method is:</p>
290
291<pre class="code">
292 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
293</pre>
294
cristy7a40ba82011-01-08 20:31:18 +0000295<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000296
297<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000298<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000299
300<h5>severity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000301<p>the severity of the error is returned here.</p>
cristy3ed852e2009-09-05 21:47:34 +0000302
303 </div>
cristy7a40ba82011-01-08 20:31:18 +0000304<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
305_8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000306<div class="doc-section">
307
cristy7a40ba82011-01-08 20:31:18 +0000308<p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p>
cristy3ed852e2009-09-05 21:47:34 +0000309
310<p>The format of the MagickGetExceptionType method is:</p>
311
312<pre class="code">
313 ExceptionType MagickGetExceptionType(const MagickWand *wand)
314</pre>
315
cristy7a40ba82011-01-08 20:31:18 +0000316<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000317
318<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000319<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000320
321 </div>
cristy7a40ba82011-01-08 20:31:18 +0000322<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
323_8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000324<div class="doc-section">
325
cristy7a40ba82011-01-08 20:31:18 +0000326<p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000327
328<p>The format of the MagickGetIteratorIndex method is:</p>
329
330<pre class="code">
cristybb503372010-05-27 20:51:26 +0000331 ssize_t MagickGetIteratorIndex(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000332</pre>
333
cristy7a40ba82011-01-08 20:31:18 +0000334<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000335
336<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000337<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000338
339 </div>
cristy7a40ba82011-01-08 20:31:18 +0000340<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
341_8c.html" id="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000342<div class="doc-section">
343
cristy7a40ba82011-01-08 20:31:18 +0000344<p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p>
cristy3ed852e2009-09-05 21:47:34 +0000345
346<p>The format of the MagickQueryConfigureOption function is:</p>
347
348<pre class="text">
349 char *MagickQueryConfigureOption(const char *option)
350</pre>
351
cristy7a40ba82011-01-08 20:31:18 +0000352<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000353
354<h5>option</h5>
cristy7a40ba82011-01-08 20:31:18 +0000355<p>the option name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000356
357 </div>
cristy7a40ba82011-01-08 20:31:18 +0000358<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
359_8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000360<div class="doc-section">
361
cristy7a40ba82011-01-08 20:31:18 +0000362<p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p>
cristy3ed852e2009-09-05 21:47:34 +0000363
364<p>The format of the MagickQueryConfigureOptions function is:</p>
365
366<pre class="text">
367 char **MagickQueryConfigureOptions(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000368 size_t *number_options)
cristy3ed852e2009-09-05 21:47:34 +0000369</pre>
370
cristy7a40ba82011-01-08 20:31:18 +0000371<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000372
373<h5>pattern</h5>
cristy7a40ba82011-01-08 20:31:18 +0000374<p>Specifies a pointer to a text string containing a pattern.</p>
cristy3ed852e2009-09-05 21:47:34 +0000375
376<h5>number_options</h5>
cristy7a40ba82011-01-08 20:31:18 +0000377<p>Returns the number of configure options in the list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000378
379
380 </div>
cristy7a40ba82011-01-08 20:31:18 +0000381<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
382_8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000383<div class="doc-section">
384
385<p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
386
387<pre class="text">
388 Element Description
389 -------------------------------------------------
390 0 character width
391 1 character height
392 2 ascender
393 3 descender
394 4 text width
395 5 text height
396 6 maximum horizontal advance
397 7 bounding box: x1
398 8 bounding box: y1
399 9 bounding box: x2
400 10 bounding box: y2
401 11 origin: x
402 12 origin: y
403</pre>
404
405<p>The format of the MagickQueryFontMetrics method is:</p>
406
407<pre class="code">
408 double *MagickQueryFontMetrics(MagickWand *wand,
409 const DrawingWand *drawing_wand,const char *text)
410</pre>
411
cristy7a40ba82011-01-08 20:31:18 +0000412<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000413
414<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000415<p>the Magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000416
417<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000418<p>the drawing wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000419
420<h5>text</h5>
cristy7a40ba82011-01-08 20:31:18 +0000421<p>the text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000422
423 </div>
cristy7a40ba82011-01-08 20:31:18 +0000424<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
425_8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000426<div class="doc-section">
427
428<p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
429
430<pre class="text">
431 Element Description
432 -------------------------------------------------
433 0 character width
434 1 character height
435 2 ascender
436 3 descender
437 4 text width
438 5 text height
439 6 maximum horizontal advance
440 7 bounding box: x1
441 8 bounding box: y1
442 9 bounding box: x2
443 10 bounding box: y2
444 11 origin: x
445 12 origin: y
446</pre>
447
cristy7a40ba82011-01-08 20:31:18 +0000448<p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000449
450<p>The format of the MagickQueryFontMetrics method is:</p>
451
452<pre class="code">
453 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
454 const DrawingWand *drawing_wand,const char *text)
455</pre>
456
cristy7a40ba82011-01-08 20:31:18 +0000457<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000458
459<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000460<p>the Magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000461
462<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000463<p>the drawing wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000464
465<h5>text</h5>
cristy7a40ba82011-01-08 20:31:18 +0000466<p>the text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000467
468 </div>
cristy7a40ba82011-01-08 20:31:18 +0000469<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
470_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000471<div class="doc-section">
472
cristy7a40ba82011-01-08 20:31:18 +0000473<p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
cristy3ed852e2009-09-05 21:47:34 +0000474
475<p>The format of the MagickQueryFonts function is:</p>
476
477<pre class="text">
cristybb503372010-05-27 20:51:26 +0000478 char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
cristy3ed852e2009-09-05 21:47:34 +0000479</pre>
480
cristy7a40ba82011-01-08 20:31:18 +0000481<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000482
483<h5>pattern</h5>
cristy7a40ba82011-01-08 20:31:18 +0000484<p>Specifies a pointer to a text string containing a pattern.</p>
cristy3ed852e2009-09-05 21:47:34 +0000485
486<h5>number_fonts</h5>
cristy7a40ba82011-01-08 20:31:18 +0000487<p>Returns the number of fonts in the list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000488
489
490 </div>
cristy7a40ba82011-01-08 20:31:18 +0000491<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
492_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000493<div class="doc-section">
494
cristy7a40ba82011-01-08 20:31:18 +0000495<p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).</p>
cristy3ed852e2009-09-05 21:47:34 +0000496
497<p>The format of the MagickQueryFonts function is:</p>
498
499<pre class="text">
500 char **MagickQueryFonts(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000501 size_t *number_formats)
cristy3ed852e2009-09-05 21:47:34 +0000502</pre>
503
cristy7a40ba82011-01-08 20:31:18 +0000504<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000505
506<h5>pattern</h5>
cristy7a40ba82011-01-08 20:31:18 +0000507<p>Specifies a pointer to a text string containing a pattern.</p>
cristy3ed852e2009-09-05 21:47:34 +0000508
509<h5>number_formats</h5>
cristy7a40ba82011-01-08 20:31:18 +0000510<p>This integer returns the number of image formats in the list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000511
512 </div>
cristy7a40ba82011-01-08 20:31:18 +0000513<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
514_8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000515<div class="doc-section">
516
cristy7a40ba82011-01-08 20:31:18 +0000517<p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
cristy3ed852e2009-09-05 21:47:34 +0000518
519<p>The format of the MagickRelinquishMemory method is:</p>
520
521<pre class="code">
522 void *MagickRelinquishMemory(void *resource)
523</pre>
524
cristy7a40ba82011-01-08 20:31:18 +0000525<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000526
527<h5>resource</h5>
cristy7a40ba82011-01-08 20:31:18 +0000528<p>Relinquish the memory associated with this resource.</p>
cristy3ed852e2009-09-05 21:47:34 +0000529
530 </div>
cristy7a40ba82011-01-08 20:31:18 +0000531<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
532_8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000533<div class="doc-section">
534
cristy7a40ba82011-01-08 20:31:18 +0000535<p>MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p>
cristy3ed852e2009-09-05 21:47:34 +0000536
537<p>The format of the MagickResetIterator method is:</p>
538
539<pre class="code">
540 void MagickResetIterator(MagickWand *wand)
541</pre>
542
cristy7a40ba82011-01-08 20:31:18 +0000543<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000544
545<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000546<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000547
548 </div>
cristy7a40ba82011-01-08 20:31:18 +0000549<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
550_8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000551<div class="doc-section">
552
cristy7a40ba82011-01-08 20:31:18 +0000553<p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000554
555<p>The format of the MagickSetFirstIterator method is:</p>
556
557<pre class="code">
558 void MagickSetFirstIterator(MagickWand *wand)
559</pre>
560
cristy7a40ba82011-01-08 20:31:18 +0000561<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000562
563<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000564<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000565
566 </div>
cristy7a40ba82011-01-08 20:31:18 +0000567<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
568_8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000569<div class="doc-section">
570
cristy7a40ba82011-01-08 20:31:18 +0000571<p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p>
cristy3ed852e2009-09-05 21:47:34 +0000572
573<p>The format of the MagickSetIteratorIndex method is:</p>
574
575<pre class="code">
576 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000577 const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +0000578</pre>
579
cristy7a40ba82011-01-08 20:31:18 +0000580<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000581
582<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000583<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000584
585<h5>index</h5>
cristy7a40ba82011-01-08 20:31:18 +0000586<p>the scene number.</p>
cristy3ed852e2009-09-05 21:47:34 +0000587
588 </div>
cristy7a40ba82011-01-08 20:31:18 +0000589<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
590_8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000591<div class="doc-section">
592
cristy7a40ba82011-01-08 20:31:18 +0000593<p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000594
595<p>The format of the MagickSetLastIterator method is:</p>
596
597<pre class="code">
598 void MagickSetLastIterator(MagickWand *wand)
599</pre>
600
cristy7a40ba82011-01-08 20:31:18 +0000601<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000602
603<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000604<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000605
606 </div>
cristy7a40ba82011-01-08 20:31:18 +0000607<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
608_8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000609<div class="doc-section">
610
cristy7a40ba82011-01-08 20:31:18 +0000611<p>MagickWandGenesis() initializes the MagickWand environment.</p>
cristy3ed852e2009-09-05 21:47:34 +0000612
613<p>The format of the MagickWandGenesis method is:</p>
614
615<pre class="code">
616 void MagickWandGenesis(void)
617</pre>
618
619 </div>
cristy7a40ba82011-01-08 20:31:18 +0000620<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
621_8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000622<div class="doc-section">
623
cristy7a40ba82011-01-08 20:31:18 +0000624<p>MagickWandTerminus() terminates the MagickWand environment.</p>
cristy3ed852e2009-09-05 21:47:34 +0000625
626<p>The format of the MaickWandTerminus method is:</p>
627
628<pre class="code">
629 void MagickWandTerminus(void)
630</pre>
631
632 </div>
cristy7a40ba82011-01-08 20:31:18 +0000633<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
634_8c.html" id="NewMagickWand">NewMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000635<div class="doc-section">
636
cristy7a40ba82011-01-08 20:31:18 +0000637<p>NewMagickWand() returns a wand required for all other methods in the API.</p>
cristy3ed852e2009-09-05 21:47:34 +0000638
639<p>The format of the NewMagickWand method is:</p>
640
641<pre class="code">
642 MagickWand *NewMagickWand(void)
643</pre>
644
645 </div>
cristy7a40ba82011-01-08 20:31:18 +0000646<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
647_8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000648<div class="doc-section">
649
cristy7a40ba82011-01-08 20:31:18 +0000650<p>NewMagickWandFromImage() returns a wand with an image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000651
652<p>The format of the NewMagickWandFromImage method is:</p>
653
654<pre class="code">
655 MagickWand *NewMagickWandFromImage(const Image *image)
656</pre>
657
cristy7a40ba82011-01-08 20:31:18 +0000658<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000659
660<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000661<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000662
663 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000664
665</div>
666
667<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000668 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000669 <span id="linkbar-center">
670 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000671 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000672 </span>
673 <span id="linkbar-east">&nbsp;</span>
674 </div>
675 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000676 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000677 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
678 </div>
679 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000680 <script type="text/javascript">
681 var _gaq = _gaq || [];
682 _gaq.push(['_setAccount', 'UA-17690367-1']);
683 _gaq.push(['_trackPageview']);
684
685 (function() {
686 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
687 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
688 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
689 })();
690 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000691</body>
692</html>