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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  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."/>
  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, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  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-2011 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="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <a href="../../index.html">\r
  53   <img src="../../images/script.png" alt="[ImageMagick]"\r
  54   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  55 <a href="http://www.networkredux.com">\r
  56   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  57   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
  58 <a href="http://www.imagemagick.org/discourse-server/">\r
  59   <img src="../../images/logo.jpg"\r
  60   alt="ImageMagick Logo"\r
  61   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  62 <a href="../../index.html">\r
  63   <img src="../../images/sprite.jpg"\r
  64   alt="ImageMagick Sprite"\r
  65   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  66 </div>\r
  67 \r
  68 <div class="westbar">\r
  69 \r
  70 <div class="menu">
  71   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  72 </div>
  73 <div class="sep"></div>\r
  74 <div class="menu">
  75   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  76 </div>
  77 <div class="sub">
  78     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  79 </div>
  80 <div class="sub">
  81     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  88 </div>
  89 <div class="sep"></div>\r
  90 <div class="menu">
  91   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  95 </div>
  96 <div class="sub">
  97     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 101 </div>
 102 <div class="menu">
 103   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 104 </div>
 105 <div class="sub">
 106     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 107 </div>
 108 <div class="sub">
 109     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div  class="menu">
 119    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 123 </div>
 124 <div class="sub">
 125     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 126  </div>
 127 <div class="menu">
 128   <a title="Resources" href="../../www/resources.html">Resources</a>
 129 </div>
 130 <div class="menu">
 131   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 132 </div>
 133 <div class="menu">
 134   <a title="Download" href="../../www/download.html">Download</a>
 135 </div>
 136 <div class="sep"></div>\r
 137 <div class="menu">
 138   <a title="Search" href="../../www/search.html">Search</a>
 139 </div>
 140 <div class="sep"></div>\r
 141 <div class="menu">
 142   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 143 </div>
 144 <div  class="sub">
 145   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div  class="menu">
 149   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 150
 151 <div class="sponsbox">
 152 <div  class="sponsor">
 153   <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 154 </div>
 155 <div  class="sponsor">
 156   <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
 157 </div>
 158 <div  class="sponsor">
 159   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
 160 </div>
 161 <div  class="sponsor">
 162   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 163 </div>
 164 <div  class="sponsor">
 165   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 166 </div>
 167 <div  class="sponsor">
 168   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 169 </div>
 170 <div class="sponsor">
 171   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
 172 </div>
 173 <div  class="sponsor">
 174   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 175 </div>
 176 <div  class="sponsor">
 177    <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011060100025 gabi.schulze-->
 178 </div>
 179 </div>
 180 </div>
 181 </div>\r
 182 \r
 183 <div class="eastbar">\r
 184   <script type="text/javascript">\r
 185   <!--\r
 186     google_ad_client = "pub-3129977114552745";\r
 187     google_ad_slot = "0574824969";\r
 188     google_ad_width = 160;\r
 189     google_ad_height = 600;\r
 190   //-->\r
 191   </script>\r
 192   <script type="text/javascript"\r
 193     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 194   </script>\r
 195 </div>\r
 196 \r
 197 <div class="main">\r
 198 \r
 199 <h1>Module magick-wand Methods</h1>
 200 <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>
 201
 202 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
 203 <div class="doc-section">
 204
 205 <p>ClearMagickWand() clears resources associated with the wand.</p>
 206
 207 <p>The format of the ClearMagickWand method is:</p>
 208
 209 <pre class="code">
 210   void ClearMagickWand(MagickWand *wand)
 211 </pre>
 212
 213 <p>A description of each parameter follows:</p>
 214
 215 <h5>wand</h5>
 216 <p>the magick wand.</p>
 217
 218  </div>
 219 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
 220 <div class="doc-section">
 221
 222 <p>CloneMagickWand() makes an exact copy of the specified wand.</p>
 223
 224 <p>The format of the CloneMagickWand method is:</p>
 225
 226 <pre class="code">
 227   MagickWand *CloneMagickWand(const MagickWand *wand)
 228 </pre>
 229
 230 <p>A description of each parameter follows:</p>
 231
 232 <h5>wand</h5>
 233 <p>the magick wand.</p>
 234
 235  </div>
 236 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
 237 <div class="doc-section">
 238
 239 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
 240
 241 <p>The format of the DestroyMagickWand method is:</p>
 242
 243 <pre class="code">
 244   MagickWand *DestroyMagickWand(MagickWand *wand)
 245 </pre>
 246
 247 <p>A description of each parameter follows:</p>
 248
 249 <h5>wand</h5>
 250 <p>the magick wand.</p>
 251
 252  </div>
 253 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="IsMagickWand">IsMagickWand</a></h2>
 254 <div class="doc-section">
 255
 256 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
 257
 258 <p>The format of the IsMagickWand method is:</p>
 259
 260 <pre class="code">
 261   MagickBooleanType IsMagickWand(const MagickWand *wand)
 262 </pre>
 263
 264 <p>A description of each parameter follows:</p>
 265
 266 <h5>wand</h5>
 267 <p>the magick wand.</p>
 268
 269  </div>
 270 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickClearException">MagickClearException</a></h2>
 271 <div class="doc-section">
 272
 273 <p>MagickClearException() clears any exceptions associated with the wand.</p>
 274
 275 <p>The format of the MagickClearException method is:</p>
 276
 277 <pre class="code">
 278   MagickBooleanType MagickClearException(MagickWand *wand)
 279 </pre>
 280
 281 <p>A description of each parameter follows:</p>
 282
 283 <h5>wand</h5>
 284 <p>the magick wand.</p>
 285
 286  </div>
 287 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetException">MagickGetException</a></h2>
 288 <div class="doc-section">
 289
 290 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
 291
 292 <p>The format of the MagickGetException method is:</p>
 293
 294 <pre class="code">
 295   char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
 296 </pre>
 297
 298 <p>A description of each parameter follows:</p>
 299
 300 <h5>wand</h5>
 301 <p>the magick wand.</p>
 302
 303 <h5>severity</h5>
 304 <p>the severity of the error is returned here.</p>
 305
 306  </div>
 307 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
 308 <div class="doc-section">
 309
 310 <p>MagickGetExceptionType() returns the exception type associated with the wand.  If no exception has occurred, UndefinedExceptionType is returned.</p>
 311
 312 <p>The format of the MagickGetExceptionType method is:</p>
 313
 314 <pre class="code">
 315   ExceptionType MagickGetExceptionType(const MagickWand *wand)
 316 </pre>
 317
 318 <p>A description of each parameter follows:</p>
 319
 320 <h5>wand</h5>
 321 <p>the magick wand.</p>
 322
 323  </div>
 324 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
 325 <div class="doc-section">
 326
 327 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
 328
 329 <p>The format of the MagickGetIteratorIndex method is:</p>
 330
 331 <pre class="code">
 332   ssize_t MagickGetIteratorIndex(MagickWand *wand)
 333 </pre>
 334
 335 <p>A description of each parameter follows:</p>
 336
 337 <h5>wand</h5>
 338 <p>the magick wand.</p>
 339
 340  </div>
 341 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
 342 <div class="doc-section">
 343
 344 <p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p>
 345
 346 <p>The format of the MagickQueryConfigureOption function is:</p>
 347
 348 <pre class="text">
 349   char *MagickQueryConfigureOption(const char *option)
 350 </pre>
 351
 352 <p>A description of each parameter follows:</p>
 353
 354 <h5>option</h5>
 355 <p>the option name.</p>
 356
 357  </div>
 358 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
 359 <div class="doc-section">
 360
 361 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g.  "*" for all).  Options include NAME, VERSION, LIB_VERSION, etc.</p>
 362
 363 <p>The format of the MagickQueryConfigureOptions function is:</p>
 364
 365 <pre class="text">
 366   char **MagickQueryConfigureOptions(const char *pattern,
 367     size_t *number_options)
 368 </pre>
 369
 370 <p>A description of each parameter follows:</p>
 371
 372 <h5>pattern</h5>
 373 <p>Specifies a pointer to a text string containing a pattern.</p>
 374
 375 <h5>number_options</h5>
 376 <p>Returns the number of configure options in the list.</p>
 377
 378
 379  </div>
 380 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
 381 <div class="doc-section">
 382
 383 <p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
 384
 385 <pre class="text">
 386       Element Description
 387       -------------------------------------------------
 388       0 character width
 389       1 character height
 390       2 ascender
 391       3 descender
 392       4 text width
 393       5 text height
 394       6 maximum horizontal advance
 395       7 bounding box: x1
 396       8 bounding box: y1
 397       9 bounding box: x2
 398      10 bounding box: y2
 399      11 origin: x
 400      12 origin: y
 401 </pre>
 402
 403 <p>The format of the MagickQueryFontMetrics method is:</p>
 404
 405 <pre class="code">
 406   double *MagickQueryFontMetrics(MagickWand *wand,
 407     const DrawingWand *drawing_wand,const char *text)
 408 </pre>
 409
 410 <p>A description of each parameter follows:</p>
 411
 412 <h5>wand</h5>
 413 <p>the Magick wand.</p>
 414
 415 <h5>drawing_wand</h5>
 416 <p>the drawing wand.</p>
 417
 418 <h5>text</h5>
 419 <p>the text.</p>
 420
 421  </div>
 422 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
 423 <div class="doc-section">
 424
 425 <p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
 426
 427 <pre class="text">
 428       Element Description
 429       -------------------------------------------------
 430       0 character width
 431       1 character height
 432       2 ascender
 433       3 descender
 434       4 text width
 435       5 text height
 436       6 maximum horizontal advance
 437       7 bounding box: x1
 438       8 bounding box: y1
 439       9 bounding box: x2
 440      10 bounding box: y2
 441      11 origin: x
 442      12 origin: y
 443 </pre>
 444
 445 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
 446
 447 <p>The format of the MagickQueryFontMetrics method is:</p>
 448
 449 <pre class="code">
 450   double *MagickQueryMultilineFontMetrics(MagickWand *wand,
 451     const DrawingWand *drawing_wand,const char *text)
 452 </pre>
 453
 454 <p>A description of each parameter follows:</p>
 455
 456 <h5>wand</h5>
 457 <p>the Magick wand.</p>
 458
 459 <h5>drawing_wand</h5>
 460 <p>the drawing wand.</p>
 461
 462 <h5>text</h5>
 463 <p>the text.</p>
 464
 465  </div>
 466 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
 467 <div class="doc-section">
 468
 469 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
 470
 471 <p>The format of the MagickQueryFonts function is:</p>
 472
 473 <pre class="text">
 474   char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
 475 </pre>
 476
 477 <p>A description of each parameter follows:</p>
 478
 479 <h5>pattern</h5>
 480 <p>Specifies a pointer to a text string containing a pattern.</p>
 481
 482 <h5>number_fonts</h5>
 483 <p>Returns the number of fonts in the list.</p>
 484
 485
 486  </div>
 487 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
 488 <div class="doc-section">
 489
 490 <p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g.  "*" for all).</p>
 491
 492 <p>The format of the MagickQueryFonts function is:</p>
 493
 494 <pre class="text">
 495   char **MagickQueryFonts(const char *pattern,
 496     size_t *number_formats)
 497 </pre>
 498
 499 <p>A description of each parameter follows:</p>
 500
 501 <h5>pattern</h5>
 502 <p>Specifies a pointer to a text string containing a pattern.</p>
 503
 504 <h5>number_formats</h5>
 505 <p>This integer returns the number of image formats in the list.</p>
 506
 507  </div>
 508 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
 509 <div class="doc-section">
 510
 511 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
 512
 513 <p>The format of the MagickRelinquishMemory method is:</p>
 514
 515 <pre class="code">
 516   void *MagickRelinquishMemory(void *resource)
 517 </pre>
 518
 519 <p>A description of each parameter follows:</p>
 520
 521 <h5>resource</h5>
 522 <p>Relinquish the memory associated with this resource.</p>
 523
 524  </div>
 525 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
 526 <div class="doc-section">
 527
 528 <p>MagickResetIterator() resets the wand iterator.  Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p>
 529
 530 <p>The format of the MagickResetIterator method is:</p>
 531
 532 <pre class="code">
 533   void MagickResetIterator(MagickWand *wand)
 534 </pre>
 535
 536 <p>A description of each parameter follows:</p>
 537
 538 <h5>wand</h5>
 539 <p>the magick wand.</p>
 540
 541  </div>
 542 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
 543 <div class="doc-section">
 544
 545 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
 546
 547 <p>The format of the MagickSetFirstIterator method is:</p>
 548
 549 <pre class="code">
 550   void MagickSetFirstIterator(MagickWand *wand)
 551 </pre>
 552
 553 <p>A description of each parameter follows:</p>
 554
 555 <h5>wand</h5>
 556 <p>the magick wand.</p>
 557
 558  </div>
 559 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
 560 <div class="doc-section">
 561
 562 <p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p>
 563
 564 <p>The format of the MagickSetIteratorIndex method is:</p>
 565
 566 <pre class="code">
 567   MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
 568     const ssize_t index)
 569 </pre>
 570
 571 <p>A description of each parameter follows:</p>
 572
 573 <h5>wand</h5>
 574 <p>the magick wand.</p>
 575
 576 <h5>index</h5>
 577 <p>the scene number.</p>
 578
 579  </div>
 580 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
 581 <div class="doc-section">
 582
 583 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
 584
 585 <p>The format of the MagickSetLastIterator method is:</p>
 586
 587 <pre class="code">
 588   void MagickSetLastIterator(MagickWand *wand)
 589 </pre>
 590
 591 <p>A description of each parameter follows:</p>
 592
 593 <h5>wand</h5>
 594 <p>the magick wand.</p>
 595
 596  </div>
 597 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
 598 <div class="doc-section">
 599
 600 <p>MagickWandGenesis() initializes the MagickWand environment.</p>
 601
 602 <p>The format of the MagickWandGenesis method is:</p>
 603
 604 <pre class="code">
 605   void MagickWandGenesis(void)
 606 </pre>
 607
 608  </div>
 609 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
 610 <div class="doc-section">
 611
 612 <p>MagickWandTerminus() terminates the MagickWand environment.</p>
 613
 614 <p>The format of the MaickWandTerminus method is:</p>
 615
 616 <pre class="code">
 617   void MagickWandTerminus(void)
 618 </pre>
 619
 620  </div>
 621 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="NewMagickWand">NewMagickWand</a></h2>
 622 <div class="doc-section">
 623
 624 <p>NewMagickWand() returns a wand required for all other methods in the API.</p>
 625
 626 <p>The format of the NewMagickWand method is:</p>
 627
 628 <pre class="code">
 629   MagickWand *NewMagickWand(void)
 630 </pre>
 631
 632  </div>
 633 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
 634 <div class="doc-section">
 635
 636 <p>NewMagickWandFromImage() returns a wand with an image.</p>
 637
 638 <p>The format of the NewMagickWandFromImage method is:</p>
 639
 640 <pre class="code">
 641   MagickWand *NewMagickWandFromImage(const Image *image)
 642 </pre>
 643
 644 <p>A description of each parameter follows:</p>
 645
 646 <h5>image</h5>
 647 <p>the image.</p>
 648
 649  </div>
 650 \r
 651 </div>\r
 652 \r
 653 <div id="linkbar">\r
 654     <span id="linkbar-west">&nbsp;</span>\r
 655     <span id="linkbar-center">\r
 656       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 657       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 658     </span>\r
 659     <span id="linkbar-east">&nbsp;</span>\r
 660   </div>\r
 661   <div class="footer">\r
 662     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 663     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 664   </div>\r
 665   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 666   <script type="text/javascript">\r
 667     var _gaq = _gaq || [];\r
 668     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 669     _gaq.push(['_trackPageview']);\r
 670 \r
 671     (function() {\r
 672       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 673       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 674       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 675     })();\r
 676   </script>\r
 677 </body>\r
 678 </html>\r