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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   7   <title>ImageMagick: MagickWand, C API for ImageMagick: Wand Methods</title>
   8   <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"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <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"/>
  16   <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"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"/>
  25   <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"/>\r
  27   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  28   <style type="text/css" media="all">\r
  29     @import url("../../www/magick.css");\r
  30   </style>\r
  31   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  32   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  33   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  34   <script type="text/javascript">\r
  35     $(document).ready(function() {\r
  36       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  37         'transitionIn'  : 'elastic',\r
  38         'transitionOut' : 'elastic',\r
  39         'overlayShow'   : false,\r
  40         'opacity'       : true\r
  41       });\r
  42     });\r
  43   </script>\r
  44 </head>\r
  45 \r
  46 <body id="www-imagemagick-org">\r
  47 <div class="titlebar">\r
  48 <a href="../../index.html">\r
  49   <img src="../../images/script.png" alt="[ImageMagick]"\r
  50   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  51 <a href="http://www.networkredux.com">\r
  52   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  53   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
  54 <a href="http://www.imagemagick.org/discourse-server/">\r
  55   <img src="../../images/logo.jpg"\r
  56   alt="ImageMagick Logo"\r
  57   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  58 <a href="../../index.html">\r
  59   <img src="../../images/sprite.jpg"\r
  60   alt="ImageMagick Sprite"\r
  61   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  62 </div>\r
  63 \r
  64 <div class="westbar">\r
  65 \r
  66 <div class="menu">
  67   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  68 </div>
  69 <div class="sep"></div>\r
  70 <div class="menu">
  71   <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>\r
  83 <div class="menu">
  84   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  91 </div>
  92 <div class="sub">
  93     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  94 </div>
  95 <div class="menu">
  96   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 106 </div>
 107 <div class="sub">
 108     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div  class="menu">
 112    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 119  </div>
 120 <div class="menu">
 121   <a title="Resources" href="../../www/resources.html">Resources</a>
 122 </div>
 123 <div class="menu">
 124   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 125 </div>
 126 <div class="menu">
 127   <a title="Download" href="../../www/download.html">Download</a>
 128 </div>
 129 <div class="sep"></div>\r
 130 <div class="menu">
 131   <a title="Search" href="../../www/search.html">Search</a>
 132 </div>
 133 <div class="sep"></div>\r
 134 <div class="menu">
 135   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 136 </div>
 137 <div  class="sub">
 138   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 139 </div>
 140 <div class="sep"></div>\r
 141 <div  class="menu">
 142   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 143
 144 <div class="sponsbox">
 145 <div  class="sponsor">
 146   <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">
 152   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
 153 </div>
 154 <div class="sponsor">
 155   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
 156 </div>
 157 <div  class="sponsor">
 158   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 159 </div>
 160 <div  class="sponsor">
 161   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 162 </div>
 163 <div  class="sponsor">
 164   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 165 </div>
 166 <div  class="sponsor">
 167    <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
 168 </div>
 169 </div>
 170 </div>
 171 </div>\r
 172 \r
 173 <div class="eastbar">\r
 174   <script type="text/javascript">\r
 175   <!--\r
 176     google_ad_client = "pub-3129977114552745";\r
 177     google_ad_slot = "0574824969";\r
 178     google_ad_width = 160;\r
 179     google_ad_height = 600;\r
 180   //-->\r
 181   </script>\r
 182   <script type="text/javascript"\r
 183     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 184   </script>\r
 185 </div>\r
 186 \r
 187 <div class="main">\r
 188 \r
 189 <h1>Module magick-wand
 190  Methods</h1>
 191 <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
 193 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 194 _8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
 195 <div class="doc-section">
 196
 197 <p>ClearMagickWand() clears resources associated with the wand.</p>
 198
 199 <p>The format of the ClearMagickWand method is:</p>
 200
 201 <pre class="code">
 202   void ClearMagickWand(MagickWand *wand)
 203 </pre>
 204
 205 <p>A description of each parameter follows:</p>
 206
 207 <h5>wand</h5>
 208 <p>the magick wand.</p>
 209
 210  </div>
 211 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 212 _8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
 213 <div class="doc-section">
 214
 215 <p>CloneMagickWand() makes an exact copy of the specified wand.</p>
 216
 217 <p>The format of the CloneMagickWand method is:</p>
 218
 219 <pre class="code">
 220   MagickWand *CloneMagickWand(const MagickWand *wand)
 221 </pre>
 222
 223 <p>A description of each parameter follows:</p>
 224
 225 <h5>wand</h5>
 226 <p>the magick wand.</p>
 227
 228  </div>
 229 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 230 _8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
 231 <div class="doc-section">
 232
 233 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
 234
 235 <p>The format of the DestroyMagickWand method is:</p>
 236
 237 <pre class="code">
 238   MagickWand *DestroyMagickWand(MagickWand *wand)
 239 </pre>
 240
 241 <p>A description of each parameter follows:</p>
 242
 243 <h5>wand</h5>
 244 <p>the magick wand.</p>
 245
 246  </div>
 247 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 248 _8c.html" id="IsMagickWand">IsMagickWand</a></h2>
 249 <div class="doc-section">
 250
 251 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
 252
 253 <p>The format of the IsMagickWand method is:</p>
 254
 255 <pre class="code">
 256   MagickBooleanType IsMagickWand(const MagickWand *wand)
 257 </pre>
 258
 259 <p>A description of each parameter follows:</p>
 260
 261 <h5>wand</h5>
 262 <p>the magick wand.</p>
 263
 264  </div>
 265 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 266 _8c.html" id="MagickClearException">MagickClearException</a></h2>
 267 <div class="doc-section">
 268
 269 <p>MagickClearException() clears any exceptions associated with the wand.</p>
 270
 271 <p>The format of the MagickClearException method is:</p>
 272
 273 <pre class="code">
 274   MagickBooleanType MagickClearException(MagickWand *wand)
 275 </pre>
 276
 277 <p>A description of each parameter follows:</p>
 278
 279 <h5>wand</h5>
 280 <p>the magick wand.</p>
 281
 282  </div>
 283 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 284 _8c.html" id="MagickGetException">MagickGetException</a></h2>
 285 <div class="doc-section">
 286
 287 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
 288
 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
 295 <p>A description of each parameter follows:</p>
 296
 297 <h5>wand</h5>
 298 <p>the magick wand.</p>
 299
 300 <h5>severity</h5>
 301 <p>the severity of the error is returned here.</p>
 302
 303  </div>
 304 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 305 _8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
 306 <div class="doc-section">
 307
 308 <p>MagickGetExceptionType() returns the exception type associated with the wand.  If no exception has occurred, UndefinedExceptionType is returned.</p>
 309
 310 <p>The format of the MagickGetExceptionType method is:</p>
 311
 312 <pre class="code">
 313   ExceptionType MagickGetExceptionType(const MagickWand *wand)
 314 </pre>
 315
 316 <p>A description of each parameter follows:</p>
 317
 318 <h5>wand</h5>
 319 <p>the magick wand.</p>
 320
 321  </div>
 322 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 323 _8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
 324 <div class="doc-section">
 325
 326 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
 327
 328 <p>The format of the MagickGetIteratorIndex method is:</p>
 329
 330 <pre class="code">
 331   ssize_t MagickGetIteratorIndex(MagickWand *wand)
 332 </pre>
 333
 334 <p>A description of each parameter follows:</p>
 335
 336 <h5>wand</h5>
 337 <p>the magick wand.</p>
 338
 339  </div>
 340 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 341 _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.wizards-toolkit.org/api/MagickWand/magick-wand
 359 _8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
 360 <div class="doc-section">
 361
 362 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g.  "*" for all).  Options include NAME, VERSION, LIB_VERSION, etc.</p>
 363
 364 <p>The format of the MagickQueryConfigureOptions function is:</p>
 365
 366 <pre class="text">
 367   char **MagickQueryConfigureOptions(const char *pattern,
 368     size_t *number_options)
 369 </pre>
 370
 371 <p>A description of each parameter follows:</p>
 372
 373 <h5>pattern</h5>
 374 <p>Specifies a pointer to a text string containing a pattern.</p>
 375
 376 <h5>number_options</h5>
 377 <p>Returns the number of configure options in the list.</p>
 378
 379
 380  </div>
 381 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 382 _8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
 383 <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
 412 <p>A description of each parameter follows:</p>
 413
 414 <h5>wand</h5>
 415 <p>the Magick wand.</p>
 416
 417 <h5>drawing_wand</h5>
 418 <p>the drawing wand.</p>
 419
 420 <h5>text</h5>
 421 <p>the text.</p>
 422
 423  </div>
 424 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 425 _8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
 426 <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
 448 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
 449
 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
 457 <p>A description of each parameter follows:</p>
 458
 459 <h5>wand</h5>
 460 <p>the Magick wand.</p>
 461
 462 <h5>drawing_wand</h5>
 463 <p>the drawing wand.</p>
 464
 465 <h5>text</h5>
 466 <p>the text.</p>
 467
 468  </div>
 469 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 470 _8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
 471 <div class="doc-section">
 472
 473 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
 474
 475 <p>The format of the MagickQueryFonts function is:</p>
 476
 477 <pre class="text">
 478   char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
 479 </pre>
 480
 481 <p>A description of each parameter follows:</p>
 482
 483 <h5>pattern</h5>
 484 <p>Specifies a pointer to a text string containing a pattern.</p>
 485
 486 <h5>number_fonts</h5>
 487 <p>Returns the number of fonts in the list.</p>
 488
 489
 490  </div>
 491 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 492 _8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
 493 <div class="doc-section">
 494
 495 <p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g.  "*" for all).</p>
 496
 497 <p>The format of the MagickQueryFonts function is:</p>
 498
 499 <pre class="text">
 500   char **MagickQueryFonts(const char *pattern,
 501     size_t *number_formats)
 502 </pre>
 503
 504 <p>A description of each parameter follows:</p>
 505
 506 <h5>pattern</h5>
 507 <p>Specifies a pointer to a text string containing a pattern.</p>
 508
 509 <h5>number_formats</h5>
 510 <p>This integer returns the number of image formats in the list.</p>
 511
 512  </div>
 513 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 514 _8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
 515 <div class="doc-section">
 516
 517 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
 518
 519 <p>The format of the MagickRelinquishMemory method is:</p>
 520
 521 <pre class="code">
 522   void *MagickRelinquishMemory(void *resource)
 523 </pre>
 524
 525 <p>A description of each parameter follows:</p>
 526
 527 <h5>resource</h5>
 528 <p>Relinquish the memory associated with this resource.</p>
 529
 530  </div>
 531 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 532 _8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
 533 <div class="doc-section">
 534
 535 <p>MagickResetIterator() resets the wand iterator.  Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p>
 536
 537 <p>The format of the MagickResetIterator method is:</p>
 538
 539 <pre class="code">
 540   void MagickResetIterator(MagickWand *wand)
 541 </pre>
 542
 543 <p>A description of each parameter follows:</p>
 544
 545 <h5>wand</h5>
 546 <p>the magick wand.</p>
 547
 548  </div>
 549 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 550 _8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
 551 <div class="doc-section">
 552
 553 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
 554
 555 <p>The format of the MagickSetFirstIterator method is:</p>
 556
 557 <pre class="code">
 558   void MagickSetFirstIterator(MagickWand *wand)
 559 </pre>
 560
 561 <p>A description of each parameter follows:</p>
 562
 563 <h5>wand</h5>
 564 <p>the magick wand.</p>
 565
 566  </div>
 567 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 568 _8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
 569 <div class="doc-section">
 570
 571 <p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p>
 572
 573 <p>The format of the MagickSetIteratorIndex method is:</p>
 574
 575 <pre class="code">
 576   MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
 577     const ssize_t index)
 578 </pre>
 579
 580 <p>A description of each parameter follows:</p>
 581
 582 <h5>wand</h5>
 583 <p>the magick wand.</p>
 584
 585 <h5>index</h5>
 586 <p>the scene number.</p>
 587
 588  </div>
 589 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 590 _8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
 591 <div class="doc-section">
 592
 593 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
 594
 595 <p>The format of the MagickSetLastIterator method is:</p>
 596
 597 <pre class="code">
 598   void MagickSetLastIterator(MagickWand *wand)
 599 </pre>
 600
 601 <p>A description of each parameter follows:</p>
 602
 603 <h5>wand</h5>
 604 <p>the magick wand.</p>
 605
 606  </div>
 607 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 608 _8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
 609 <div class="doc-section">
 610
 611 <p>MagickWandGenesis() initializes the MagickWand environment.</p>
 612
 613 <p>The format of the MagickWandGenesis method is:</p>
 614
 615 <pre class="code">
 616   void MagickWandGenesis(void)
 617 </pre>
 618
 619  </div>
 620 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 621 _8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
 622 <div class="doc-section">
 623
 624 <p>MagickWandTerminus() terminates the MagickWand environment.</p>
 625
 626 <p>The format of the MaickWandTerminus method is:</p>
 627
 628 <pre class="code">
 629   void MagickWandTerminus(void)
 630 </pre>
 631
 632  </div>
 633 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 634 _8c.html" id="NewMagickWand">NewMagickWand</a></h2>
 635 <div class="doc-section">
 636
 637 <p>NewMagickWand() returns a wand required for all other methods in the API.</p>
 638
 639 <p>The format of the NewMagickWand method is:</p>
 640
 641 <pre class="code">
 642   MagickWand *NewMagickWand(void)
 643 </pre>
 644
 645  </div>
 646 <h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
 647 _8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
 648 <div class="doc-section">
 649
 650 <p>NewMagickWandFromImage() returns a wand with an image.</p>
 651
 652 <p>The format of the NewMagickWandFromImage method is:</p>
 653
 654 <pre class="code">
 655   MagickWand *NewMagickWandFromImage(const Image *image)
 656 </pre>
 657
 658 <p>A description of each parameter follows:</p>
 659
 660 <h5>image</h5>
 661 <p>the image.</p>
 662
 663  </div>
 664 \r
 665 </div>\r
 666 \r
 667 <div id="linkbar">\r
 668     <span id="linkbar-west">&nbsp;</span>\r
 669     <span id="linkbar-center">\r
 670       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 671       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 672     </span>\r
 673     <span id="linkbar-east">&nbsp;</span>\r
 674   </div>\r
 675   <div class="footer">\r
 676     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 677     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 678   </div>\r
 679   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 680   <script type="text/javascript">\r
 681     var _gaq = _gaq || [];\r
 682     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 683     _gaq.push(['_trackPageview']);\r
 684 \r
 685     (function() {\r
 686       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 687       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 688       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 689     })();\r
 690   </script>\r
 691 </body>\r
 692 </html>\r