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