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.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <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>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 157 _8c.html" target="source" name="ClearMagickWand">ClearMagickWand</a></h2>
 158 <div class="doc-section">
 159
 160 <p>ClearMagickWand() clears resources associated with the wand.</p></ol>
 161
 162 <p>The format of the ClearMagickWand method is:</p>
 163
 164 <pre class="code">
 165   void ClearMagickWand(MagickWand *wand)
 166 </pre>
 167
 168 <p>A description of each parameter follows:</p></ol>
 169
 170 <h5>wand</h5>
 171 <ol><p>the magick wand.</p></ol>
 172
 173  </div>
 174 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 175 _8c.html" target="source" name="CloneMagickWand">CloneMagickWand</a></h2>
 176 <div class="doc-section">
 177
 178 <p>CloneMagickWand() makes an exact copy of the specified wand.</p></ol>
 179
 180 <p>The format of the CloneMagickWand method is:</p>
 181
 182 <pre class="code">
 183   MagickWand *CloneMagickWand(const MagickWand *wand)
 184 </pre>
 185
 186 <p>A description of each parameter follows:</p></ol>
 187
 188 <h5>wand</h5>
 189 <ol><p>the magick wand.</p></ol>
 190
 191  </div>
 192 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 193 _8c.html" target="source" name="DestroyMagickWand">DestroyMagickWand</a></h2>
 194 <div class="doc-section">
 195
 196 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p></ol>
 197
 198 <p>The format of the DestroyMagickWand method is:</p>
 199
 200 <pre class="code">
 201   MagickWand *DestroyMagickWand(MagickWand *wand)
 202 </pre>
 203
 204 <p>A description of each parameter follows:</p></ol>
 205
 206 <h5>wand</h5>
 207 <ol><p>the magick wand.</p></ol>
 208
 209  </div>
 210 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 211 _8c.html" target="source" name="IsMagickWand">IsMagickWand</a></h2>
 212 <div class="doc-section">
 213
 214 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p></ol>
 215
 216 <p>The format of the IsMagickWand method is:</p>
 217
 218 <pre class="code">
 219   MagickBooleanType IsMagickWand(const MagickWand *wand)
 220 </pre>
 221
 222 <p>A description of each parameter follows:</p></ol>
 223
 224 <h5>wand</h5>
 225 <ol><p>the magick wand.</p></ol>
 226
 227  </div>
 228 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 229 _8c.html" target="source" name="MagickClearException">MagickClearException</a></h2>
 230 <div class="doc-section">
 231
 232 <p>MagickClearException() clears any exceptions associated with the wand.</p></ol>
 233
 234 <p>The format of the MagickClearException method is:</p>
 235
 236 <pre class="code">
 237   MagickBooleanType MagickClearException(MagickWand *wand)
 238 </pre>
 239
 240 <p>A description of each parameter follows:</p></ol>
 241
 242 <h5>wand</h5>
 243 <ol><p>the magick wand.</p></ol>
 244
 245  </div>
 246 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 247 _8c.html" target="source" name="MagickGetException">MagickGetException</a></h2>
 248 <div class="doc-section">
 249
 250 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
 251
 252 <p>The format of the MagickGetException method is:</p>
 253
 254 <pre class="code">
 255   char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
 256 </pre>
 257
 258 <p>A description of each parameter follows:</p></ol>
 259
 260 <h5>wand</h5>
 261 <ol><p>the magick wand.</p></ol>
 262
 263 <h5>severity</h5>
 264 <ol><p>the severity of the error is returned here.</p></ol>
 265
 266  </div>
 267 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 268 _8c.html" target="source" name="MagickGetExceptionType">MagickGetExceptionType</a></h2>
 269 <div class="doc-section">
 270
 271 <p>MagickGetExceptionType() returns the exception type associated with the wand.  If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
 272
 273 <p>The format of the MagickGetExceptionType method is:</p>
 274
 275 <pre class="code">
 276   ExceptionType MagickGetExceptionType(const MagickWand *wand)
 277 </pre>
 278
 279 <p>A description of each parameter follows:</p></ol>
 280
 281 <h5>wand</h5>
 282 <ol><p>the magick wand.</p></ol>
 283
 284  </div>
 285 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 286 _8c.html" target="source" name="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
 287 <div class="doc-section">
 288
 289 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p></ol>
 290
 291 <p>The format of the MagickGetIteratorIndex method is:</p>
 292
 293 <pre class="code">
 294   long MagickGetIteratorIndex(MagickWand *wand)
 295 </pre>
 296
 297 <p>A description of each parameter follows:</p></ol>
 298
 299 <h5>wand</h5>
 300 <ol><p>the magick wand.</p></ol>
 301
 302  </div>
 303 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 304 _8c.html" target="source" name="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
 305 <div class="doc-section">
 306
 307 <p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p></ol>
 308
 309 <p>The format of the MagickQueryConfigureOption function is:</p>
 310
 311 <pre class="text">
 312   char *MagickQueryConfigureOption(const char *option)
 313 </pre>
 314
 315 <p>A description of each parameter follows:</p></ol>
 316
 317 <h5>option</h5>
 318 <ol><p>the option name.</p></ol>
 319
 320  </div>
 321 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 322 _8c.html" target="source" name="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
 323 <div class="doc-section">
 324
 325 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g.  "*" for all).  Options include NAME, VERSION, LIB_VERSION, etc.</p></ol>
 326
 327 <p>The format of the MagickQueryConfigureOptions function is:</p>
 328
 329 <pre class="text">
 330   char **MagickQueryConfigureOptions(const char *pattern,
 331     unsigned long *number_options)
 332 </pre>
 333
 334 <p>A description of each parameter follows:</p></ol>
 335
 336 <h5>pattern</h5>
 337 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 338
 339 <h5>number_options</h5>
 340 <ol><p>Returns the number of configure options in the list.</p></ol>
 341
 342
 343  </div>
 344 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 345 _8c.html" target="source" name="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
 346 <div class="doc-section">
 347
 348 <p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
 349
 350 <pre class="text">
 351       Element Description
 352       -------------------------------------------------
 353       0 character width
 354       1 character height
 355       2 ascender
 356       3 descender
 357       4 text width
 358       5 text height
 359       6 maximum horizontal advance
 360       7 bounding box: x1
 361       8 bounding box: y1
 362       9 bounding box: x2
 363      10 bounding box: y2
 364      11 origin: x
 365      12 origin: y
 366 </pre>
 367
 368 <p>The format of the MagickQueryFontMetrics method is:</p>
 369
 370 <pre class="code">
 371   double *MagickQueryFontMetrics(MagickWand *wand,
 372     const DrawingWand *drawing_wand,const char *text)
 373 </pre>
 374
 375 <p>A description of each parameter follows:</p></ol>
 376
 377 <h5>wand</h5>
 378 <ol><p>the Magick wand.</p></ol>
 379
 380 <h5>drawing_wand</h5>
 381 <ol><p>the drawing wand.</p></ol>
 382
 383 <h5>text</h5>
 384 <ol><p>the text.</p></ol>
 385
 386  </div>
 387 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 388 _8c.html" target="source" name="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
 389 <div class="doc-section">
 390
 391 <p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
 392
 393 <pre class="text">
 394       Element Description
 395       -------------------------------------------------
 396       0 character width
 397       1 character height
 398       2 ascender
 399       3 descender
 400       4 text width
 401       5 text height
 402       6 maximum horizontal advance
 403       7 bounding box: x1
 404       8 bounding box: y1
 405       9 bounding box: x2
 406      10 bounding box: y2
 407      11 origin: x
 408      12 origin: y
 409 </pre>
 410
 411 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
 412
 413 <p>The format of the MagickQueryFontMetrics method is:</p>
 414
 415 <pre class="code">
 416   double *MagickQueryMultilineFontMetrics(MagickWand *wand,
 417     const DrawingWand *drawing_wand,const char *text)
 418 </pre>
 419
 420 <p>A description of each parameter follows:</p></ol>
 421
 422 <h5>wand</h5>
 423 <ol><p>the Magick wand.</p></ol>
 424
 425 <h5>drawing_wand</h5>
 426 <ol><p>the drawing wand.</p></ol>
 427
 428 <h5>text</h5>
 429 <ol><p>the text.</p></ol>
 430
 431  </div>
 432 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 433 _8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
 434 <div class="doc-section">
 435
 436 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p></ol>
 437
 438 <p>The format of the MagickQueryFonts function is:</p>
 439
 440 <pre class="text">
 441   char **MagickQueryFonts(const char *pattern,unsigned long *number_fonts)
 442 </pre>
 443
 444 <p>A description of each parameter follows:</p></ol>
 445
 446 <h5>pattern</h5>
 447 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 448
 449 <h5>number_fonts</h5>
 450 <ol><p>Returns the number of fonts in the list.</p></ol>
 451
 452
 453  </div>
 454 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 455 _8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
 456 <div class="doc-section">
 457
 458 <p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g.  "*" for all).</p></ol>
 459
 460 <p>The format of the MagickQueryFonts function is:</p>
 461
 462 <pre class="text">
 463   char **MagickQueryFonts(const char *pattern,
 464     unsigned long *number_formats)
 465 </pre>
 466
 467 <p>A description of each parameter follows:</p></ol>
 468
 469 <h5>pattern</h5>
 470 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 471
 472 <h5>number_formats</h5>
 473 <ol><p>This integer returns the number of image formats in the list.</p></ol>
 474
 475  </div>
 476 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 477 _8c.html" target="source" name="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
 478 <div class="doc-section">
 479
 480 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p></ol>
 481
 482 <p>The format of the MagickRelinquishMemory method is:</p>
 483
 484 <pre class="code">
 485   void *MagickRelinquishMemory(void *resource)
 486 </pre>
 487
 488 <p>A description of each parameter follows:</p></ol>
 489
 490 <h5>resource</h5>
 491 <ol><p>Relinquish the memory associated with this resource.</p></ol>
 492
 493  </div>
 494 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 495 _8c.html" target="source" name="MagickResetIterator">MagickResetIterator</a></h2>
 496 <div class="doc-section">
 497
 498 <p>MagickResetIterator() resets the wand iterator.  Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p></ol>
 499
 500 <p>The format of the MagickResetIterator method is:</p>
 501
 502 <pre class="code">
 503   void MagickResetIterator(MagickWand *wand)
 504 </pre>
 505
 506 <p>A description of each parameter follows:</p></ol>
 507
 508 <h5>wand</h5>
 509 <ol><p>the magick wand.</p></ol>
 510
 511  </div>
 512 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 513 _8c.html" target="source" name="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
 514 <div class="doc-section">
 515
 516 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p></ol>
 517
 518 <p>The format of the MagickSetFirstIterator method is:</p>
 519
 520 <pre class="code">
 521   void MagickSetFirstIterator(MagickWand *wand)
 522 </pre>
 523
 524 <p>A description of each parameter follows:</p></ol>
 525
 526 <h5>wand</h5>
 527 <ol><p>the magick wand.</p></ol>
 528
 529  </div>
 530 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 531 _8c.html" target="source" name="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
 532 <div class="doc-section">
 533
 534 <p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p></ol>
 535
 536 <p>The format of the MagickSetIteratorIndex method is:</p>
 537
 538 <pre class="code">
 539   MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
 540     const long index)
 541 </pre>
 542
 543 <p>A description of each parameter follows:</p></ol>
 544
 545 <h5>wand</h5>
 546 <ol><p>the magick wand.</p></ol>
 547
 548 <h5>index</h5>
 549 <ol><p>the scene number.</p></ol>
 550
 551  </div>
 552 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 553 _8c.html" target="source" name="MagickSetLastIterator">MagickSetLastIterator</a></h2>
 554 <div class="doc-section">
 555
 556 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p></ol>
 557
 558 <p>The format of the MagickSetLastIterator method is:</p>
 559
 560 <pre class="code">
 561   void MagickSetLastIterator(MagickWand *wand)
 562 </pre>
 563
 564 <p>A description of each parameter follows:</p></ol>
 565
 566 <h5>wand</h5>
 567 <ol><p>the magick wand.</p></ol>
 568
 569  </div>
 570 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 571 _8c.html" target="source" name="MagickWandGenesis">MagickWandGenesis</a></h2>
 572 <div class="doc-section">
 573
 574 <p>MagickWandGenesis() initializes the MagickWand environment.</p></ol>
 575
 576 <p>The format of the MagickWandGenesis method is:</p>
 577
 578 <pre class="code">
 579   void MagickWandGenesis(void)
 580 </pre>
 581
 582  </div>
 583 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 584 _8c.html" target="source" name="MagickWandTerminus">MagickWandTerminus</a></h2>
 585 <div class="doc-section">
 586
 587 <p>MagickWandTerminus() terminates the MagickWand environment.</p></ol>
 588
 589 <p>The format of the MaickWandTerminus method is:</p>
 590
 591 <pre class="code">
 592   void MagickWandTerminus(void)
 593 </pre>
 594
 595  </div>
 596 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 597 _8c.html" target="source" name="NewMagickWand">NewMagickWand</a></h2>
 598 <div class="doc-section">
 599
 600 <p>NewMagickWand() returns a wand required for all other methods in the API.</p></ol>
 601
 602 <p>The format of the NewMagickWand method is:</p>
 603
 604 <pre class="code">
 605   MagickWand *NewMagickWand(void)
 606 </pre>
 607
 608  </div>
 609 <h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
 610 _8c.html" target="source" name="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
 611 <div class="doc-section">
 612
 613 <p>NewMagickWandFromImage() returns a wand with an image.</p></ol>
 614
 615 <p>The format of the NewMagickWandFromImage method is:</p>
 616
 617 <pre class="code">
 618   MagickWand *NewMagickWandFromImage(const Image *image)
 619 </pre>
 620
 621 <p>A description of each parameter follows:</p></ol>
 622
 623 <h5>image</h5>
 624 <ol><p>the image.</p></ol>
 625
 626  </div>
 627 \r
 628 </div>\r
 629 \r
 630 <div id="linkbar">\r
 631  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 632     <span id="linkbar-center">\r
 633       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 634       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 635     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 636     </span>\r
 637     <span id="linkbar-east">&nbsp;</span>\r
 638   </div>\r
 639   <div class="footer">\r
 640     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 641     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 642   </div>\r
 643   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 644 </body>\r
 645 </html>\r