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