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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  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="Generator" content="PHP"/>
  16   <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"/>
  17   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <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>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 154 _8c.html" target="source" name="ClearMagickWand">ClearMagickWand</a></h2>
 155 <div class="doc-section">
 156
 157 <p>ClearMagickWand() clears resources associated with the wand.</p></ol>
 158
 159 <p>The format of the ClearMagickWand method is:</p>
 160
 161 <pre class="code">
 162   void ClearMagickWand(MagickWand *wand)
 163 </pre>
 164
 165 <p>A description of each parameter follows:</p></ol>
 166
 167 <h5>wand</h5>
 168 <ol><p>the magick wand.</p></ol>
 169
 170  </div>
 171 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 172 _8c.html" target="source" name="CloneMagickWand">CloneMagickWand</a></h2>
 173 <div class="doc-section">
 174
 175 <p>CloneMagickWand() makes an exact copy of the specified wand.</p></ol>
 176
 177 <p>The format of the CloneMagickWand method is:</p>
 178
 179 <pre class="code">
 180   MagickWand *CloneMagickWand(const MagickWand *wand)
 181 </pre>
 182
 183 <p>A description of each parameter follows:</p></ol>
 184
 185 <h5>wand</h5>
 186 <ol><p>the magick wand.</p></ol>
 187
 188  </div>
 189 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 190 _8c.html" target="source" name="DestroyMagickWand">DestroyMagickWand</a></h2>
 191 <div class="doc-section">
 192
 193 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p></ol>
 194
 195 <p>The format of the DestroyMagickWand method is:</p>
 196
 197 <pre class="code">
 198   MagickWand *DestroyMagickWand(MagickWand *wand)
 199 </pre>
 200
 201 <p>A description of each parameter follows:</p></ol>
 202
 203 <h5>wand</h5>
 204 <ol><p>the magick wand.</p></ol>
 205
 206  </div>
 207 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 208 _8c.html" target="source" name="IsMagickWand">IsMagickWand</a></h2>
 209 <div class="doc-section">
 210
 211 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p></ol>
 212
 213 <p>The format of the IsMagickWand method is:</p>
 214
 215 <pre class="code">
 216   MagickBooleanType IsMagickWand(const MagickWand *wand)
 217 </pre>
 218
 219 <p>A description of each parameter follows:</p></ol>
 220
 221 <h5>wand</h5>
 222 <ol><p>the magick wand.</p></ol>
 223
 224  </div>
 225 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 226 _8c.html" target="source" name="MagickClearException">MagickClearException</a></h2>
 227 <div class="doc-section">
 228
 229 <p>MagickClearException() clears any exceptions associated with the wand.</p></ol>
 230
 231 <p>The format of the MagickClearException method is:</p>
 232
 233 <pre class="code">
 234   MagickBooleanType MagickClearException(MagickWand *wand)
 235 </pre>
 236
 237 <p>A description of each parameter follows:</p></ol>
 238
 239 <h5>wand</h5>
 240 <ol><p>the magick wand.</p></ol>
 241
 242  </div>
 243 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 244 _8c.html" target="source" name="MagickGetException">MagickGetException</a></h2>
 245 <div class="doc-section">
 246
 247 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
 248
 249 <p>The format of the MagickGetException method is:</p>
 250
 251 <pre class="code">
 252   char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
 253 </pre>
 254
 255 <p>A description of each parameter follows:</p></ol>
 256
 257 <h5>wand</h5>
 258 <ol><p>the magick wand.</p></ol>
 259
 260 <h5>severity</h5>
 261 <ol><p>the severity of the error is returned here.</p></ol>
 262
 263  </div>
 264 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 265 _8c.html" target="source" name="MagickGetExceptionType">MagickGetExceptionType</a></h2>
 266 <div class="doc-section">
 267
 268 <p>MagickGetExceptionType() returns the exception type associated with the wand.  If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
 269
 270 <p>The format of the MagickGetExceptionType method is:</p>
 271
 272 <pre class="code">
 273   ExceptionType MagickGetExceptionType(const MagickWand *wand)
 274 </pre>
 275
 276 <p>A description of each parameter follows:</p></ol>
 277
 278 <h5>wand</h5>
 279 <ol><p>the magick wand.</p></ol>
 280
 281  </div>
 282 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 283 _8c.html" target="source" name="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
 284 <div class="doc-section">
 285
 286 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p></ol>
 287
 288 <p>The format of the MagickGetIteratorIndex method is:</p>
 289
 290 <pre class="code">
 291   long MagickGetIteratorIndex(MagickWand *wand)
 292 </pre>
 293
 294 <p>A description of each parameter follows:</p></ol>
 295
 296 <h5>wand</h5>
 297 <ol><p>the magick wand.</p></ol>
 298
 299  </div>
 300 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 301 _8c.html" target="source" name="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
 302 <div class="doc-section">
 303
 304 <p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p></ol>
 305
 306 <p>The format of the MagickQueryConfigureOption function is:</p>
 307
 308 <pre class="text">
 309   char *MagickQueryConfigureOption(const char *option)
 310 </pre>
 311
 312 <p>A description of each parameter follows:</p></ol>
 313
 314 <h5>option</h5>
 315 <ol><p>the option name.</p></ol>
 316
 317  </div>
 318 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 319 _8c.html" target="source" name="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
 320 <div class="doc-section">
 321
 322 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g.  "*" for all).  Options include NAME, VERSION, LIB_VERSION, etc.</p></ol>
 323
 324 <p>The format of the MagickQueryConfigureOptions function is:</p>
 325
 326 <pre class="text">
 327   char **MagickQueryConfigureOptions(const char *pattern,
 328     unsigned long *number_options)
 329 </pre>
 330
 331 <p>A description of each parameter follows:</p></ol>
 332
 333 <h5>pattern</h5>
 334 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 335
 336 <h5>number_options</h5>
 337 <ol><p>Returns the number of configure options in the list.</p></ol>
 338
 339
 340  </div>
 341 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 342 _8c.html" target="source" name="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
 343 <div class="doc-section">
 344
 345 <p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
 346
 347 <pre class="text">
 348       Element Description
 349       -------------------------------------------------
 350       0 character width
 351       1 character height
 352       2 ascender
 353       3 descender
 354       4 text width
 355       5 text height
 356       6 maximum horizontal advance
 357       7 bounding box: x1
 358       8 bounding box: y1
 359       9 bounding box: x2
 360      10 bounding box: y2
 361      11 origin: x
 362      12 origin: y
 363 </pre>
 364
 365 <p>The format of the MagickQueryFontMetrics method is:</p>
 366
 367 <pre class="code">
 368   double *MagickQueryFontMetrics(MagickWand *wand,
 369     const DrawingWand *drawing_wand,const char *text)
 370 </pre>
 371
 372 <p>A description of each parameter follows:</p></ol>
 373
 374 <h5>wand</h5>
 375 <ol><p>the Magick wand.</p></ol>
 376
 377 <h5>drawing_wand</h5>
 378 <ol><p>the drawing wand.</p></ol>
 379
 380 <h5>text</h5>
 381 <ol><p>the text.</p></ol>
 382
 383  </div>
 384 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 385 _8c.html" target="source" name="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
 386 <div class="doc-section">
 387
 388 <p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
 389
 390 <pre class="text">
 391       Element Description
 392       -------------------------------------------------
 393       0 character width
 394       1 character height
 395       2 ascender
 396       3 descender
 397       4 text width
 398       5 text height
 399       6 maximum horizontal advance
 400       7 bounding box: x1
 401       8 bounding box: y1
 402       9 bounding box: x2
 403      10 bounding box: y2
 404      11 origin: x
 405      12 origin: y
 406 </pre>
 407
 408 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
 409
 410 <p>The format of the MagickQueryFontMetrics method is:</p>
 411
 412 <pre class="code">
 413   double *MagickQueryMultilineFontMetrics(MagickWand *wand,
 414     const DrawingWand *drawing_wand,const char *text)
 415 </pre>
 416
 417 <p>A description of each parameter follows:</p></ol>
 418
 419 <h5>wand</h5>
 420 <ol><p>the Magick wand.</p></ol>
 421
 422 <h5>drawing_wand</h5>
 423 <ol><p>the drawing wand.</p></ol>
 424
 425 <h5>text</h5>
 426 <ol><p>the text.</p></ol>
 427
 428  </div>
 429 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 430 _8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
 431 <div class="doc-section">
 432
 433 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p></ol>
 434
 435 <p>The format of the MagickQueryFonts function is:</p>
 436
 437 <pre class="text">
 438   char **MagickQueryFonts(const char *pattern,unsigned long *number_fonts)
 439 </pre>
 440
 441 <p>A description of each parameter follows:</p></ol>
 442
 443 <h5>pattern</h5>
 444 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 445
 446 <h5>number_fonts</h5>
 447 <ol><p>Returns the number of fonts in the list.</p></ol>
 448
 449
 450  </div>
 451 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 452 _8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
 453 <div class="doc-section">
 454
 455 <p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g.  "*" for all).</p></ol>
 456
 457 <p>The format of the MagickQueryFonts function is:</p>
 458
 459 <pre class="text">
 460   char **MagickQueryFonts(const char *pattern,
 461     unsigned long *number_formats)
 462 </pre>
 463
 464 <p>A description of each parameter follows:</p></ol>
 465
 466 <h5>pattern</h5>
 467 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 468
 469 <h5>number_formats</h5>
 470 <ol><p>This integer returns the number of image formats in the list.</p></ol>
 471
 472  </div>
 473 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 474 _8c.html" target="source" name="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
 475 <div class="doc-section">
 476
 477 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p></ol>
 478
 479 <p>The format of the MagickRelinquishMemory method is:</p>
 480
 481 <pre class="code">
 482   void *MagickRelinquishMemory(void *resource)
 483 </pre>
 484
 485 <p>A description of each parameter follows:</p></ol>
 486
 487 <h5>resource</h5>
 488 <ol><p>Relinquish the memory associated with this resource.</p></ol>
 489
 490  </div>
 491 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 492 _8c.html" target="source" name="MagickResetIterator">MagickResetIterator</a></h2>
 493 <div class="doc-section">
 494
 495 <p>MagickResetIterator() resets the wand iterator.  Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p></ol>
 496
 497 <p>The format of the MagickResetIterator method is:</p>
 498
 499 <pre class="code">
 500   void MagickResetIterator(MagickWand *wand)
 501 </pre>
 502
 503 <p>A description of each parameter follows:</p></ol>
 504
 505 <h5>wand</h5>
 506 <ol><p>the magick wand.</p></ol>
 507
 508  </div>
 509 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 510 _8c.html" target="source" name="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
 511 <div class="doc-section">
 512
 513 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p></ol>
 514
 515 <p>The format of the MagickSetFirstIterator method is:</p>
 516
 517 <pre class="code">
 518   void MagickSetFirstIterator(MagickWand *wand)
 519 </pre>
 520
 521 <p>A description of each parameter follows:</p></ol>
 522
 523 <h5>wand</h5>
 524 <ol><p>the magick wand.</p></ol>
 525
 526  </div>
 527 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 528 _8c.html" target="source" name="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
 529 <div class="doc-section">
 530
 531 <p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p></ol>
 532
 533 <p>The format of the MagickSetIteratorIndex method is:</p>
 534
 535 <pre class="code">
 536   MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
 537     const long index)
 538 </pre>
 539
 540 <p>A description of each parameter follows:</p></ol>
 541
 542 <h5>wand</h5>
 543 <ol><p>the magick wand.</p></ol>
 544
 545 <h5>index</h5>
 546 <ol><p>the scene number.</p></ol>
 547
 548  </div>
 549 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 550 _8c.html" target="source" name="MagickSetLastIterator">MagickSetLastIterator</a></h2>
 551 <div class="doc-section">
 552
 553 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p></ol>
 554
 555 <p>The format of the MagickSetLastIterator method is:</p>
 556
 557 <pre class="code">
 558   void MagickSetLastIterator(MagickWand *wand)
 559 </pre>
 560
 561 <p>A description of each parameter follows:</p></ol>
 562
 563 <h5>wand</h5>
 564 <ol><p>the magick wand.</p></ol>
 565
 566  </div>
 567 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 568 _8c.html" target="source" name="MagickWandGenesis">MagickWandGenesis</a></h2>
 569 <div class="doc-section">
 570
 571 <p>MagickWandGenesis() initializes the MagickWand environment.</p></ol>
 572
 573 <p>The format of the MagickWandGenesis method is:</p>
 574
 575 <pre class="code">
 576   void MagickWandGenesis(void)
 577 </pre>
 578
 579  </div>
 580 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 581 _8c.html" target="source" name="MagickWandTerminus">MagickWandTerminus</a></h2>
 582 <div class="doc-section">
 583
 584 <p>MagickWandTerminus() terminates the MagickWand environment.</p></ol>
 585
 586 <p>The format of the MaickWandTerminus method is:</p>
 587
 588 <pre class="code">
 589   void MagickWandTerminus(void)
 590 </pre>
 591
 592  </div>
 593 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 594 _8c.html" target="source" name="NewMagickWand">NewMagickWand</a></h2>
 595 <div class="doc-section">
 596
 597 <p>NewMagickWand() returns a wand required for all other methods in the API.</p></ol>
 598
 599 <p>The format of the NewMagickWand method is:</p>
 600
 601 <pre class="code">
 602   MagickWand *NewMagickWand(void)
 603 </pre>
 604
 605  </div>
 606 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 607 _8c.html" target="source" name="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
 608 <div class="doc-section">
 609
 610 <p>NewMagickWandFromImage() returns a wand with an image.</p></ol>
 611
 612 <p>The format of the NewMagickWandFromImage method is:</p>
 613
 614 <pre class="code">
 615   MagickWand *NewMagickWandFromImage(const Image *image)
 616 </pre>
 617
 618 <p>A description of each parameter follows:</p></ol>
 619
 620 <h5>image</h5>
 621 <ol><p>the image.</p></ol>
 622
 623  </div>
 624 \r
 625 </div>\r
 626 \r
 627 <div id="linkbar">\r
 628  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 629     <span id="linkbar-center">\r
 630       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 631       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 632     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 633     </span>\r
 634     <span id="linkbar-east">&nbsp;</span>\r
 635   </div>\r
 636   <div class="footer">\r
 637     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 638     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 639   </div>\r
 640   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 641 </body>\r
 642 </html>\r