granicus.if.org Git - imagemagick/blob - www/api/magick-wand.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html version="-//W3C//DTD XHTML 1.1//EN"
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   8 <head>
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  11   <title>ImageMagick: MagickWand, C API for ImageMagick: Wand Methods</title>
  12   <meta http-equiv="content-language" content="en-US"/>
  13   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="application-name" content="ImageMagick"/>
  16   <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 automagically."/>
  17   <meta name="application-url" content="http://www.imagemagick.org"/>
  18   <meta name="generator" content="PHP"/>
  19   <meta name="keywords" content="magickwc, api, for, imagemagick:, wmethods, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  20   <meta name="rating" content="GENERAL"/>
  21   <meta name="robots" content="INDEX, FOLLOW"/>
  22   <meta name="generator" content="ImageMagick Studio LLC"/>
  23   <meta name="author" content="ImageMagick Studio LLC"/>
  24   <meta name="revisit-after" content="2 DAYS"/>
  25   <meta name="resource-type" content="document"/>
  26   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
  27   <meta name="distribution" content="Global"/>
  28   <link rel="icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="canonical" href="http://www.imagemagick.org" />
  31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  32   <!-- Add jQuery library -->
  33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  34
  35   <!-- Optionaly include easing and/or mousewheel plugins -->
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  38
  39   <!-- Add fancyBox -->
  40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  42
  43   <!-- Optionaly include button and/or thumbnail helpers -->
  44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  46
  47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  49   <script type="text/javascript">
  50         $(document).ready(function() {
  51                 $(".fancybox").fancybox();
  52         });
  53   </script>
  54   <!-- ImageMagick style -->
  55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  56   <style type="text/css" media="all">
  57     @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");
  58   </style>
  59 </head>
  60
  61 <body id="www-imagemagick-org">
  62 <div class="titlebar">
  63 <div style="margin: 17px auto; float: left;">
  64   <script type="text/javascript">
  65   <!--
  66     google_ad_client = "pub-3129977114552745";
  67     google_ad_slot = "5439289906";
  68     google_ad_width = 728;
  69     google_ad_height = 90;
  70   //-->
  71   </script>
  72   <script type="text/javascript"
  73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  74   </script>
  75 </div>
  76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">
  77   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"
  78   alt="ImageMagick Logo"
  79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">
  81   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"
  82   alt="ImageMagick Sprite"
  83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  84 </div>
  85
  86 <div class="westbar">
  87
  88 <div class="menu">
  89   <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
  90 </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
 105 </div>
 106 <div class="sep"></div>
 107 <div class="menu">
 108   <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 118 </div>
 119 <div class="menu">
 120   <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
 133 </div>
 134 <div class="sep"></div>
 135 <div  class="menu">
 136    <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
 137 </div>
 138 <div class="sub">
 139     <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
 140 </div>
 141 <div class="sub">
 142     <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
 143  </div>
 144 <div class="menu">
 145   <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
 146 </div>
 147 <div class="menu">
 148   <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
 149 </div>
 150 <div class="menu">
 151   <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
 152 </div>
 153 <div class="sep"></div>
 154 <div class="menu">
 155   <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
 156 </div>
 157 <div class="sep"></div>
 158 <div class="menu">
 159   <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
 160 </div>
 161 <div  class="sub">
 162   <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
 163 </div>
 164 <div class="sep"></div>
 165 <div class="menu">
 166   <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
 167
 168   <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 170 <div class="sponsbox">
 171 <div class="sponsor">
 172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 173 </div>
 174 <div class="sponsor">
 175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 176 </div>
 177 <div class="sponsor">
 178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 179 </div>
 180 <div class="sponsor">
 181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 182 </div>
 183 <div class="sponsor">
 184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 185 </div>
 186 <div class="sponsor">
 187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 188 </div>
 189 <div class="sponsor">
 190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 191 </div>
 192 <div class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 194 </div>
 195 <div class="sponsor">
 196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 197 </div>
 198 <div class="sponsor">
 199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 200 </div>
 201 <div class="sponsor">
 202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 203 </div>
 204 <div class="sponsor">
 205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 206 </div>
 207 <div  class="sponsor">
 208    <a rel="follow" title="Sponsor: Kaffeemaschinen reparatur" href="http://www.kaffeemaschinen-reparatur.de">Kaffeemaschinen reparatur</a><!-- 2012080100030 Temurbas atlas-multimedia-->
 209 </div>
 210 <div class="sponsor">
 211    <a rel="follow" title="Sponsor: Fototapete - Tapetendruck" href="http://www.druck-expert.com/Fototapete-Tapetendruck,category,8830.html">Fototapete - Tapetendruck</a><!-- 2012100100155 info@druck-->
 212 </div>
 213 </div>
 214 </div>
 215 </div>
 216
 217 <div class="eastbar">
 218   <div class="g-plusone" id="gplusone"></div>
 219   <script type="text/javascript">
 220     window.___gcfg = {
 221       lang: 'en-US'
 222     };
 223
 224     (function() {
 225       var po = document.createElement('script');
 226       po.type = 'text/javascript'; po.async = true;
 227       po.src = 'https://apis.google.com/js/plusone.js';
 228       var script = document.getElementsByTagName('script')[0];
 229       script.parentNode.insertBefore(po, script);
 230     })();
 231     var gplusone = document.getElementById("gplusone");
 232     gplusone.setAttribute("data-size","medium");
 233     gplusone.setAttribute("data-count","false");
 234   </script>
 235 </div>
 236
 237 <div class="main">
 238
 239 <h1>Module magick-wand Methods</h1>
 240 <p class="navigation-index">[<a href="magick-wand.html#ClearMagickWand">ClearMagickWand</a> &bull; <a href="magick-wand.html#CloneMagickWand">CloneMagickWand</a> &bull; <a href="magick-wand.html#DestroyMagickWand">DestroyMagickWand</a> &bull; <a href="magick-wand.html#IsMagickWand">IsMagickWand</a> &bull; <a href="magick-wand.html#MagickClearException">MagickClearException</a> &bull; <a href="magick-wand.html#MagickGetException">MagickGetException</a> &bull; <a href="magick-wand.html#MagickGetExceptionType">MagickGetExceptionType</a> &bull; <a href="magick-wand.html#MagickGetIteratorIndex">MagickGetIteratorIndex</a> &bull; <a href="magick-wand.html#MagickQueryConfigureOption">MagickQueryConfigureOption</a> &bull; <a href="magick-wand.html#MagickQueryConfigureOptions">MagickQueryConfigureOptions</a> &bull; <a href="magick-wand.html#MagickQueryFontMetrics">MagickQueryFontMetrics</a> &bull; <a href="magick-wand.html#MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a> &bull; <a href="magick-wand.html#MagickQueryFonts">MagickQueryFonts</a> &bull; <a href="magick-wand.html#MagickQueryFonts">MagickQueryFonts</a> &bull; <a href="magick-wand.html#MagickRelinquishMemory">MagickRelinquishMemory</a> &bull; <a href="magick-wand.html#MagickResetIterator">MagickResetIterator</a> &bull; <a href="magick-wand.html#MagickSetFirstIterator">MagickSetFirstIterator</a> &bull; <a href="magick-wand.html#MagickSetIteratorIndex">MagickSetIteratorIndex</a> &bull; <a href="magick-wand.html#MagickSetLastIterator">MagickSetLastIterator</a> &bull; <a href="magick-wand.html#MagickWandGenesis">MagickWandGenesis</a> &bull; <a href="magick-wand.html#MagickWandTerminus">MagickWandTerminus</a> &bull; <a href="magick-wand.html#NewMagickWand">NewMagickWand</a> &bull; <a href="magick-wand.html#NewMagickWandFromImage">NewMagickWandFromImage</a>]</p>
 241
 242 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
 243 <div class="doc-section">
 244
 245 <p>ClearMagickWand() clears resources associated with the wand, leaving the wand blank, and ready to be used for a new set of images.</p>
 246
 247 <p>The format of the ClearMagickWand method is:</p>
 248
 249 <pre class="code">
 250   void ClearMagickWand(MagickWand *wand)
 251 </pre>
 252
 253 <p>A description of each parameter follows:</p>
 254
 255 <h5>wand</h5>
 256 <p>the magick wand.</p>
 257
 258  </div>
 259 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
 260 <div class="doc-section">
 261
 262 <p>CloneMagickWand() makes an exact copy of the specified wand.</p>
 263
 264 <p>The format of the CloneMagickWand method is:</p>
 265
 266 <pre class="code">
 267   MagickWand *CloneMagickWand(const MagickWand *wand)
 268 </pre>
 269
 270 <p>A description of each parameter follows:</p>
 271
 272 <h5>wand</h5>
 273 <p>the magick wand.</p>
 274
 275  </div>
 276 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
 277 <div class="doc-section">
 278
 279 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
 280
 281 <p>The format of the DestroyMagickWand method is:</p>
 282
 283 <pre class="code">
 284   MagickWand *DestroyMagickWand(MagickWand *wand)
 285 </pre>
 286
 287 <p>A description of each parameter follows:</p>
 288
 289 <h5>wand</h5>
 290 <p>the magick wand.</p>
 291
 292  </div>
 293 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="IsMagickWand">IsMagickWand</a></h2>
 294 <div class="doc-section">
 295
 296 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
 297
 298 <p>The format of the IsMagickWand method is:</p>
 299
 300 <pre class="code">
 301   MagickBooleanType IsMagickWand(const MagickWand *wand)
 302 </pre>
 303
 304 <p>A description of each parameter follows:</p>
 305
 306 <h5>wand</h5>
 307 <p>the magick wand.</p>
 308
 309  </div>
 310 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickClearException">MagickClearException</a></h2>
 311 <div class="doc-section">
 312
 313 <p>MagickClearException() clears any exceptions associated with the wand.</p>
 314
 315 <p>The format of the MagickClearException method is:</p>
 316
 317 <pre class="code">
 318   MagickBooleanType MagickClearException(MagickWand *wand)
 319 </pre>
 320
 321 <p>A description of each parameter follows:</p>
 322
 323 <h5>wand</h5>
 324 <p>the magick wand.</p>
 325
 326  </div>
 327 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetException">MagickGetException</a></h2>
 328 <div class="doc-section">
 329
 330 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
 331
 332 <p>The format of the MagickGetException method is:</p>
 333
 334 <pre class="code">
 335   char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
 336 </pre>
 337
 338 <p>A description of each parameter follows:</p>
 339
 340 <h5>wand</h5>
 341 <p>the magick wand.</p>
 342
 343 <h5>severity</h5>
 344 <p>the severity of the error is returned here.</p>
 345
 346  </div>
 347 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
 348 <div class="doc-section">
 349
 350 <p>MagickGetExceptionType() returns the exception type associated with the wand.  If no exception has occurred, UndefinedExceptionType is returned.</p>
 351
 352 <p>The format of the MagickGetExceptionType method is:</p>
 353
 354 <pre class="code">
 355   ExceptionType MagickGetExceptionType(const MagickWand *wand)
 356 </pre>
 357
 358 <p>A description of each parameter follows:</p>
 359
 360 <h5>wand</h5>
 361 <p>the magick wand.</p>
 362
 363  </div>
 364 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
 365 <div class="doc-section">
 366
 367 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
 368
 369 <p>The format of the MagickGetIteratorIndex method is:</p>
 370
 371 <pre class="code">
 372   ssize_t MagickGetIteratorIndex(MagickWand *wand)
 373 </pre>
 374
 375 <p>A description of each parameter follows:</p>
 376
 377 <h5>wand</h5>
 378 <p>the magick wand.</p>
 379
 380  </div>
 381 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
 382 <div class="doc-section">
 383
 384 <p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p>
 385
 386 <p>The format of the MagickQueryConfigureOption function is:</p>
 387
 388 <pre class="text">
 389   char *MagickQueryConfigureOption(const char *option)
 390 </pre>
 391
 392 <p>A description of each parameter follows:</p>
 393
 394 <h5>option</h5>
 395 <p>the option name.</p>
 396
 397  </div>
 398 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
 399 <div class="doc-section">
 400
 401 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g.  "*" for all).  Options include NAME, VERSION, LIB_VERSION, etc.</p>
 402
 403 <p>The format of the MagickQueryConfigureOptions function is:</p>
 404
 405 <pre class="text">
 406   char **MagickQueryConfigureOptions(const char *pattern,
 407     size_t *number_options)
 408 </pre>
 409
 410 <p>A description of each parameter follows:</p>
 411
 412 <h5>pattern</h5>
 413 <p>Specifies a pointer to a text string containing a pattern.</p>
 414
 415 <h5>number_options</h5>
 416 <p>Returns the number of configure options in the list.</p>
 417
 418
 419  </div>
 420 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
 421 <div class="doc-section">
 422
 423 <p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
 424
 425 <pre class="text">
 426       Element Description
 427       -------------------------------------------------
 428       0 character width
 429       1 character height
 430       2 ascender
 431       3 descender
 432       4 text width
 433       5 text height
 434       6 maximum horizontal advance
 435       7 bounding box: x1
 436       8 bounding box: y1
 437       9 bounding box: x2
 438      10 bounding box: y2
 439      11 origin: x
 440      12 origin: y
 441 </pre>
 442
 443 <p>The format of the MagickQueryFontMetrics method is:</p>
 444
 445 <pre class="code">
 446   double *MagickQueryFontMetrics(MagickWand *wand,
 447     const DrawingWand *drawing_wand,const char *text)
 448 </pre>
 449
 450 <p>A description of each parameter follows:</p>
 451
 452 <h5>wand</h5>
 453 <p>the Magick wand.</p>
 454
 455 <h5>drawing_wand</h5>
 456 <p>the drawing wand.</p>
 457
 458 <h5>text</h5>
 459 <p>the text.</p>
 460
 461  </div>
 462 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
 463 <div class="doc-section">
 464
 465 <p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
 466
 467 <pre class="text">
 468       Element Description
 469       -------------------------------------------------
 470       0 character width
 471       1 character height
 472       2 ascender
 473       3 descender
 474       4 text width
 475       5 text height
 476       6 maximum horizontal advance
 477       7 bounding box: x1
 478       8 bounding box: y1
 479       9 bounding box: x2
 480      10 bounding box: y2
 481      11 origin: x
 482      12 origin: y
 483 </pre>
 484
 485 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
 486
 487 <p>The format of the MagickQueryFontMetrics method is:</p>
 488
 489 <pre class="code">
 490   double *MagickQueryMultilineFontMetrics(MagickWand *wand,
 491     const DrawingWand *drawing_wand,const char *text)
 492 </pre>
 493
 494 <p>A description of each parameter follows:</p>
 495
 496 <h5>wand</h5>
 497 <p>the Magick wand.</p>
 498
 499 <h5>drawing_wand</h5>
 500 <p>the drawing wand.</p>
 501
 502 <h5>text</h5>
 503 <p>the text.</p>
 504
 505  </div>
 506 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
 507 <div class="doc-section">
 508
 509 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
 510
 511 <p>The format of the MagickQueryFonts function is:</p>
 512
 513 <pre class="text">
 514   char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
 515 </pre>
 516
 517 <p>A description of each parameter follows:</p>
 518
 519 <h5>pattern</h5>
 520 <p>Specifies a pointer to a text string containing a pattern.</p>
 521
 522 <h5>number_fonts</h5>
 523 <p>Returns the number of fonts in the list.</p>
 524
 525
 526  </div>
 527 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
 528 <div class="doc-section">
 529
 530 <p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g.  "*" for all).</p>
 531
 532 <p>The format of the MagickQueryFonts function is:</p>
 533
 534 <pre class="text">
 535   char **MagickQueryFonts(const char *pattern,
 536     size_t *number_formats)
 537 </pre>
 538
 539 <p>A description of each parameter follows:</p>
 540
 541 <h5>pattern</h5>
 542 <p>Specifies a pointer to a text string containing a pattern.</p>
 543
 544 <h5>number_formats</h5>
 545 <p>This integer returns the number of image formats in the list.</p>
 546
 547  </div>
 548 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
 549 <div class="doc-section">
 550
 551 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
 552
 553 <p>The format of the MagickRelinquishMemory method is:</p>
 554
 555 <pre class="code">
 556   void *MagickRelinquishMemory(void *resource)
 557 </pre>
 558
 559 <p>A description of each parameter follows:</p>
 560
 561 <h5>resource</h5>
 562 <p>Relinquish the memory associated with this resource.</p>
 563
 564  </div>
 565 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
 566 <div class="doc-section">
 567
 568 <p>MagickResetIterator() resets the wand iterator.</p>
 569
 570 <p>It is typically used either before iterating though images, or before calling specific functions such as  MagickAppendImages() to append all images together.</p>
 571
 572 <p>Afterward you can use MagickNextImage() to iterate over all the images in a wand container, starting with the first image.</p>
 573
 574 <p>Using this before MagickAddImages() or MagickReadImages() will cause new images to be inserted between the first and second image.</p>
 575
 576 <p>The format of the MagickResetIterator method is:</p>
 577
 578 <pre class="code">
 579   void MagickResetIterator(MagickWand *wand)
 580 </pre>
 581
 582 <p>A description of each parameter follows:</p>
 583
 584 <h5>wand</h5>
 585 <p>the magick wand.</p>
 586
 587  </div>
 588 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
 589 <div class="doc-section">
 590
 591 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
 592
 593 <p>After using any images added to the wand using MagickAddImage() or MagickReadImage() will be prepended before any image in the wand.</p>
 594
 595 <p>Also the current image has been set to the first image (if any) in the Magick Wand.  Using MagickNextImage() will then set teh current image to the second image in the list (if present).</p>
 596
 597 <p>This operation is similar to MagickResetIterator() but differs in how MagickAddImage(), MagickReadImage(), and MagickNextImage() behaves afterward.</p>
 598
 599 <p>The format of the MagickSetFirstIterator method is:</p>
 600
 601 <pre class="code">
 602   void MagickSetFirstIterator(MagickWand *wand)
 603 </pre>
 604
 605 <p>A description of each parameter follows:</p>
 606
 607 <h5>wand</h5>
 608 <p>the magick wand.</p>
 609
 610  </div>
 611 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
 612 <div class="doc-section">
 613
 614 <p>MagickSetIteratorIndex() set the iterator to the given position in the image list specified with the index parameter.  A zero index will set the first image as current, and so on.  Negative indexes can be used to specify an image relative to the end of the images in the wand, with -1 being the last image in the wand.</p>
 615
 616 <p>If the index is invalid (range too large for number of images in wand) the function will return MagickFalse, but no 'exception' will be raised, as it is not actually an error.  In that case the current image will not change.</p>
 617
 618 <p>After using any images added to the wand using MagickAddImage() or MagickReadImage() will be added after the image indexed, regardless of if a zero (first image in list) or negative index (from end) is used.</p>
 619
 620 <p>Jumping to index 0 is similar to MagickResetIterator() but differs in how MagickNextImage() behaves afterward.</p>
 621
 622 <p>The format of the MagickSetIteratorIndex method is:</p>
 623
 624 <pre class="code">
 625   MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
 626     const ssize_t index)
 627 </pre>
 628
 629 <p>A description of each parameter follows:</p>
 630
 631 <h5>wand</h5>
 632 <p>the magick wand.</p>
 633
 634 <h5>index</h5>
 635 <p>the scene number.</p>
 636
 637  </div>
 638 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
 639 <div class="doc-section">
 640
 641 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
 642
 643 <p>The last image is actually the current image, and the next use of MagickPreviousImage() will not change this allowing this function to be used to iterate over the images in the reverse direction. In this sense it is more like  MagickResetIterator() than MagickSetFirstIterator().</p>
 644
 645 <p>Typically this function is used before MagickAddImage(), MagickReadImage() functions to ensure new images are appended to the very end of wand's image list.</p>
 646
 647 <p>The format of the MagickSetLastIterator method is:</p>
 648
 649 <pre class="code">
 650   void MagickSetLastIterator(MagickWand *wand)
 651 </pre>
 652
 653 <p>A description of each parameter follows:</p>
 654
 655 <h5>wand</h5>
 656 <p>the magick wand.</p>
 657
 658  </div>
 659 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
 660 <div class="doc-section">
 661
 662 <p>MagickWandGenesis() initializes the MagickWand environment.</p>
 663
 664 <p>The format of the MagickWandGenesis method is:</p>
 665
 666 <pre class="code">
 667   void MagickWandGenesis(void)
 668 </pre>
 669
 670  </div>
 671 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
 672 <div class="doc-section">
 673
 674 <p>MagickWandTerminus() terminates the MagickWand environment.</p>
 675
 676 <p>The format of the MaickWandTerminus method is:</p>
 677
 678 <pre class="code">
 679   void MagickWandTerminus(void)
 680 </pre>
 681
 682  </div>
 683 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="NewMagickWand">NewMagickWand</a></h2>
 684 <div class="doc-section">
 685
 686 <p>NewMagickWand() returns a wand required for all other methods in the API. A fatal exception is thrown if there is not enough memory to allocate the wand.   Use DestroyMagickWand() to dispose of the wand when it is no longer needed.</p>
 687
 688 <p>The format of the NewMagickWand method is:</p>
 689
 690 <pre class="code">
 691   MagickWand *NewMagickWand(void)
 692 </pre>
 693
 694  </div>
 695 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
 696 <div class="doc-section">
 697
 698 <p>NewMagickWandFromImage() returns a wand with an image.</p>
 699
 700 <p>The format of the NewMagickWandFromImage method is:</p>
 701
 702 <pre class="code">
 703   MagickWand *NewMagickWandFromImage(const Image *image)
 704 </pre>
 705
 706 <p>A description of each parameter follows:</p>
 707
 708 <h5>image</h5>
 709 <p>the image.</p>
 710
 711  </div>
 712
 713 </div>
 714
 715 <div id="linkbar">
 716     <span id="linkbar-west">&nbsp;</span>
 717     <span id="linkbar-center">
 718       <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
 719       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 720     </span>
 721     <span id="linkbar-east">&nbsp;</span>
 722   </div>
 723   <div class="footer">
 724     <span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
 725     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
 726   </div>
 727   <div style="clear: both; margin: 0; width: 100%; "></div>
 728   <script type="text/javascript">
 729     var _gaq = _gaq || [];
 730     _gaq.push(['_setAccount', 'UA-17690367-1']);
 731     _gaq.push(['_trackPageview']);
 732
 733     (function() {
 734       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 735       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 736       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 737     })();
 738   </script>
 739 </body>
 740 </html>