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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html version="-//W3C//DTD XHTML 1.1//EN"
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   8 <head>
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Working with Image Lists</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="application-name" content="ImageMagick"/>
  16   <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images automagically."/>
  17   <meta name="application-url" content="http://www.imagemagick.org"/>
  18   <meta name="generator" content="PHP"/>
  19   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, working, with, image, lists, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  20   <meta name="rating" content="GENERAL"/>
  21   <meta name="robots" content="INDEX, FOLLOW"/>
  22   <meta name="generator" content="ImageMagick Studio LLC"/>
  23   <meta name="author" content="ImageMagick Studio LLC"/>
  24   <meta name="revisit-after" content="2 DAYS"/>
  25   <meta name="resource-type" content="document"/>
  26   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
  27   <meta name="distribution" content="Global"/>
  28   <link rel="icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="canonical" href="http://www.imagemagick.org" />
  31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  32   <!-- Add jQuery library -->
  33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  34
  35   <!-- Optionaly include easing and/or mousewheel plugins -->
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  38
  39   <!-- Add fancyBox -->
  40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  42
  43   <!-- Optionaly include button and/or thumbnail helpers -->
  44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  46
  47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  49   <script type="text/javascript">
  50         $(document).ready(function() {
  51                 $(".fancybox").fancybox();
  52         });
  53   </script>
  54   <!-- ImageMagick style -->
  55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  56   <style type="text/css" media="all">
  57     @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");
  58   </style>
  59 </head>
  60
  61 <body id="www-imagemagick-org">
  62 <div class="titlebar">
  63 <div style="margin: 17px auto; float: left;">
  64   <script type="text/javascript">
  65   <!--
  66     google_ad_client = "pub-3129977114552745";
  67     google_ad_slot = "5439289906";
  68     google_ad_width = 728;
  69     google_ad_height = 90;
  70   //-->
  71   </script>
  72   <script type="text/javascript"
  73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  74   </script>
  75 </div>
  76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">
  77   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"
  78   alt="ImageMagick Logo"
  79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">
  81   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"
  82   alt="ImageMagick Sprite"
  83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  84 </div>
  85
  86 <div class="westbar">
  87
  88 <div class="menu">
  89   <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
  90 </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
 105 </div>
 106 <div class="sep"></div>
 107 <div class="menu">
 108   <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 118 </div>
 119 <div class="menu">
 120   <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
 133 </div>
 134 <div class="sep"></div>
 135 <div  class="menu">
 136    <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
 137 </div>
 138 <div class="sub">
 139     <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
 140 </div>
 141 <div class="sub">
 142     <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
 143  </div>
 144 <div class="menu">
 145   <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
 146 </div>
 147 <div class="menu">
 148   <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
 149 </div>
 150 <div class="menu">
 151   <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
 152 </div>
 153 <div class="sep"></div>
 154 <div class="menu">
 155   <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
 156 </div>
 157 <div class="sep"></div>
 158 <div class="menu">
 159   <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
 160 </div>
 161 <div  class="sub">
 162   <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
 163 </div>
 164 <div class="sep"></div>
 165 <div class="menu">
 166   <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
 167
 168   <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 170 <div class="sponsbox">
 171 <div class="sponsor">
 172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 173 </div>
 174 <div class="sponsor">
 175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 176 </div>
 177 <div class="sponsor">
 178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 179 </div>
 180 <div class="sponsor">
 181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 182 </div>
 183 <div class="sponsor">
 184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 185 </div>
 186 <div class="sponsor">
 187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 188 </div>
 189 <div class="sponsor">
 190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 191 </div>
 192 <div class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 194 </div>
 195 <div class="sponsor">
 196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 197 </div>
 198 <div class="sponsor">
 199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 200 </div>
 201 <div class="sponsor">
 202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 203 </div>
 204 <div class="sponsor">
 205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 206 </div>
 207 <div class="sponsor">
 208    <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 209 </div>
 210 <div class="sponsor">
 211    <a rel="follow" title="Sponsor: Waschmaschinen Reparatur Berlin" href="http://www.waschmaschinen-reparaturen-berlin.de">Waschmaschinen Reparatur Berlin</a><!-- 2012070100030 Temurbas@autoteile-->
 212 </div>
 213 </div>
 214 </div>
 215 </div>
 216
 217 <div class="eastbar">
 218   <div class="g-plusone" id="gplusone"></div>
 219   <script type="text/javascript">
 220     window.___gcfg = {
 221       lang: 'en-US'
 222     };
 223
 224     (function() {
 225       var po = document.createElement('script');
 226       po.type = 'text/javascript'; po.async = true;
 227       po.src = 'https://apis.google.com/js/plusone.js';
 228       var script = document.getElementsByTagName('script')[0];
 229       script.parentNode.insertBefore(po, script);
 230     })();
 231     var gplusone = document.getElementById("gplusone");
 232     gplusone.setAttribute("data-size","medium");
 233     gplusone.setAttribute("data-count","false");
 234   </script>
 235 </div>
 236
 237 <div class="main">
 238
 239 <h1>Module list Methods</h1>
 240 <p class="navigation-index">[<a href="list.html#AppendImageToList">AppendImageToList</a> &bull; <a href="list.html#CloneImageList">CloneImageList</a> &bull; <a href="list.html#CloneImages">CloneImages</a> &bull; <a href="list.html#DeleteImageFromList">DeleteImageFromList</a> &bull; <a href="list.html#DeleteImages">DeleteImages</a> &bull; <a href="list.html#DestroyImageList">DestroyImageList</a> &bull; <a href="list.html#DuplicateImages">DuplicateImages</a> &bull; <a href="list.html#GetFirstImageInList">GetFirstImageInList</a> &bull; <a href="list.html#GetImageFromList">GetImageFromList</a> &bull; <a href="list.html#GetImageIndexInList">GetImageIndexInList</a> &bull; <a href="list.html#GetImageListLength">GetImageListLength</a> &bull; <a href="list.html#GetLastImageInList">GetLastImageInList</a> &bull; <a href="list.html#GetNextImageInList">GetNextImageInList</a> &bull; <a href="list.html#GetPreviousImageInList">GetPreviousImageInList</a> &bull; <a href="list.html#ImageListToArray">ImageListToArray</a> &bull; <a href="list.html#InsertImageInList">InsertImageInList</a> &bull; <a href="list.html#NewImageList">NewImageList</a> &bull; <a href="list.html#PrependImageToList">PrependImageToList</a> &bull; <a href="list.html#RemoveImageFromList">RemoveImageFromList</a> &bull; <a href="list.html#RemoveFirstImageFromList">RemoveFirstImageFromList</a> &bull; <a href="list.html#RemoveLastImageFromList">RemoveLastImageFromList</a> &bull; <a href="list.html#ReplaceImageInList">ReplaceImageInList</a> &bull; <a href="list.html#ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a> &bull; <a href="list.html#ReverseImageList">ReverseImageList</a> &bull; <a href="list.html#SpliceImageIntoList">SpliceImageIntoList</a> &bull; <a href="list.html#SplitImageList">SplitImageList</a>]</p>
 241
 242 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="AppendImageToList">AppendImageToList</a></h2>
 243 <div class="doc-section">
 244
 245 <p>AppendImageToList() appends the second image list to the end of the first list.  The given image list pointer is left unchanged, unless it was empty.</p>
 246
 247 <p>The format of the AppendImageToList method is:</p>
 248
 249 <pre class="code">
 250   AppendImageToList(Image *images,const Image *image)
 251 </pre>
 252
 253 <p>A description of each parameter follows:</p>
 254
 255 <h5>images</h5>
 256 <p>the image list to be appended to.</p>
 257
 258 <h5>image</h5>
 259 <p>the appended image or image list.</p>
 260
 261  </div>
 262 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImageList">CloneImageList</a></h2>
 263 <div class="doc-section">
 264
 265 <p>CloneImageList() returns a duplicate of the image list.</p>
 266
 267 <p>The format of the CloneImageList method is:</p>
 268
 269 <pre class="code">
 270   Image *CloneImageList(const Image *images,ExceptionInfo *exception)
 271 </pre>
 272
 273 <p>A description of each parameter follows:</p>
 274
 275 <h5>images</h5>
 276 <p>the image list.</p>
 277
 278 <h5>exception</h5>
 279 <p>return any errors or warnings in this structure.</p>
 280
 281  </div>
 282 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImages">CloneImages</a></h2>
 283 <div class="doc-section">
 284
 285 <p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
 286
 287 <p>The numbers start at 0 for the first image in the list, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times to clone them multiple times. Images refered beyond the available number of images in list are ignored.</p>
 288
 289 <p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p>
 290
 291 <p>The format of the CloneImages method is:</p>
 292
 293 <pre class="code">
 294   Image *CloneImages(const Image *images,const char *scenes,
 295     ExceptionInfo *exception)
 296 </pre>
 297
 298 <p>A description of each parameter follows:</p>
 299
 300 <h5>images</h5>
 301 <p>the image sequence.</p>
 302
 303 <h5>scenes</h5>
 304 <p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p>
 305
 306 <h5>exception</h5>
 307 <p>return any errors or warnings in this structure.</p>
 308
 309  </div>
 310 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImageFromList">DeleteImageFromList</a></h2>
 311 <div class="doc-section">
 312
 313 <p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p>
 314
 315 <p>The format of the DeleteImageFromList method is:</p>
 316
 317 <pre class="code">
 318   DeleteImageFromList(Image **images)
 319 </pre>
 320
 321 <p>A description of each parameter follows:</p>
 322
 323 <h5>images</h5>
 324 <p>the image list.</p>
 325
 326  </div>
 327 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImages">DeleteImages</a></h2>
 328 <div class="doc-section">
 329
 330 <p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
 331
 332 <p>The numbers start at 0 for the first image, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times without problems. Image refered beyond the available number of images in list are ignored.</p>
 333
 334 <p>If the referenced images are in the reverse order, that range will be completely ignored, unlike CloneImages().</p>
 335
 336 <p>The format of the DeleteImages method is:</p>
 337
 338 <pre class="code">
 339   DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
 340 </pre>
 341
 342 <p>A description of each parameter follows:</p>
 343
 344 <h5>images</h5>
 345 <p>the image sequence.</p>
 346
 347 <h5>scenes</h5>
 348 <p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p>
 349
 350 <h5>exception</h5>
 351 <p>return any errors or warnings in this structure.</p>
 352
 353  </div>
 354 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DestroyImageList">DestroyImageList</a></h2>
 355 <div class="doc-section">
 356
 357 <p>DestroyImageList() destroys an image list.</p>
 358
 359 <p>The format of the DestroyImageList method is:</p>
 360
 361 <pre class="code">
 362   Image *DestroyImageList(Image *image)
 363 </pre>
 364
 365 <p>A description of each parameter follows:</p>
 366
 367 <h5>image</h5>
 368 <p>the image sequence.</p>
 369
 370  </div>
 371 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DuplicateImages">DuplicateImages</a></h2>
 372 <div class="doc-section">
 373
 374 <p>DuplicateImages() duplicates one or more images from an image sequence, using a count and a comma separated list of image numbers or ranges.</p>
 375
 376 <p>The numbers start at 0 for the first image, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times without problems. Image refered beyond the available number of images in list are ignored.</p>
 377
 378 <p>The format of the DuplicateImages method is:</p>
 379
 380 <pre class="code">
 381   Image *DuplicateImages(Image *images,const size_t number_duplicates,
 382     const char *scenes,ExceptionInfo *exception)
 383 </pre>
 384
 385 <p>A description of each parameter follows:</p>
 386
 387 <h5>images</h5>
 388 <p>the image sequence.</p>
 389
 390 <h5>number_duplicates</h5>
 391 <p>duplicate the image sequence this number of times.</p>
 392
 393 <h5>scenes</h5>
 394 <p>This character string specifies which scenes to duplicate (e.g. 1,3-5,-2-6,2).</p>
 395
 396 <h5>exception</h5>
 397 <p>return any errors or warnings in this structure.</p>
 398
 399  </div>
 400 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetFirstImageInList">GetFirstImageInList</a></h2>
 401 <div class="doc-section">
 402
 403 <p>GetFirstImageInList() returns a pointer to the first image in the list.</p>
 404
 405 <p>The format of the GetFirstImageInList method is:</p>
 406
 407 <pre class="code">
 408   Image *GetFirstImageInList(const Image *images)
 409 </pre>
 410
 411 <p>A description of each parameter follows:</p>
 412
 413 <h5>images</h5>
 414 <p>the image list.</p>
 415
 416  </div>
 417 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageFromList">GetImageFromList</a></h2>
 418 <div class="doc-section">
 419
 420 <p>GetImageFromList() returns an image at the specified index from the image list. Starting with 0 as the first image in the list.</p>
 421
 422 <p>A negative offset will return the image from the end of the list, such that an index of -1 is the last image.</p>
 423
 424 <p>If no such image exists at the specified offset a NULL image pointer is returned.  This will only happen if index is less that the negative of the list length, or larger than list length -1.  EG: ( -N to N-1 )</p>
 425
 426 <p>The format of the GetImageFromList method is:</p>
 427
 428 <pre class="code">
 429   Image *GetImageFromList(const Image *images,const ssize_t index)
 430 </pre>
 431
 432 <p>A description of each parameter follows:</p>
 433
 434 <h5>images</h5>
 435 <p>the image list.</p>
 436
 437 <h5>index</h5>
 438 <p>the position within the list.</p>
 439
 440  </div>
 441 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageIndexInList">GetImageIndexInList</a></h2>
 442 <div class="doc-section">
 443
 444 <p>GetImageIndexInList() returns the offset in the list of the specified image.</p>
 445
 446 <p>The format of the GetImageIndexInList method is:</p>
 447
 448 <pre class="code">
 449   ssize_t GetImageIndexInList(const Image *images)
 450 </pre>
 451
 452 <p>A description of each parameter follows:</p>
 453
 454 <h5>images</h5>
 455 <p>the image list.</p>
 456
 457  </div>
 458 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageListLength">GetImageListLength</a></h2>
 459 <div class="doc-section">
 460
 461 <p>GetImageListLength() returns the length of the list (the number of images in the list).</p>
 462
 463 <p>The format of the GetImageListLength method is:</p>
 464
 465 <pre class="code">
 466   size_t GetImageListLength(const Image *images)
 467 </pre>
 468
 469 <p>A description of each parameter follows:</p>
 470
 471 <h5>images</h5>
 472 <p>the image list.</p>
 473
 474  </div>
 475 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetLastImageInList">GetLastImageInList</a></h2>
 476 <div class="doc-section">
 477
 478 <p>GetLastImageInList() returns a pointer to the last image in the list.</p>
 479
 480 <p>The format of the GetLastImageInList method is:</p>
 481
 482 <pre class="code">
 483   Image *GetLastImageInList(const Image *images)
 484 </pre>
 485
 486 <p>A description of each parameter follows:</p>
 487
 488 <h5>images</h5>
 489 <p>the image list.</p>
 490
 491  </div>
 492 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetNextImageInList">GetNextImageInList</a></h2>
 493 <div class="doc-section">
 494
 495 <p>GetNextImageInList() returns the next image in the list.</p>
 496
 497 <p>The format of the GetNextImageInList method is:</p>
 498
 499 <pre class="code">
 500   Image *GetNextImageInList(const Image *images)
 501 </pre>
 502
 503 <p>A description of each parameter follows:</p>
 504
 505 <h5>images</h5>
 506 <p>the image list.</p>
 507
 508  </div>
 509 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetPreviousImageInList">GetPreviousImageInList</a></h2>
 510 <div class="doc-section">
 511
 512 <p>GetPreviousImageInList() returns the previous image in the list.</p>
 513
 514 <p>The format of the GetPreviousImageInList method is:</p>
 515
 516 <pre class="code">
 517   Image *GetPreviousImageInList(const Image *images)
 518 </pre>
 519
 520 <p>A description of each parameter follows:</p>
 521
 522 <h5>images</h5>
 523 <p>the image list.</p>
 524
 525  </div>
 526 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ImageListToArray">ImageListToArray</a></h2>
 527 <div class="doc-section">
 528
 529 <p>ImageListToArray() is a convenience method that converts an image list to a sequential array, with a NULL image pointer at the end of the array.</p>
 530
 531 <p>The images remain part of the original image list, with the array providing an alternative means of indexing the image array.</p>
 532
 533 <p>group = ImageListToArray(images, exception); while (i = 0; group[i] != (Image *) NULL; i++) printf("s\n", group[i]->filename); printf("d images\n", i); group = RelinquishMagickMemory(group);</p>
 534
 535 <p>The format of the ImageListToArray method is:</p>
 536
 537 <pre class="code">
 538   Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
 539 </pre>
 540
 541 <p>A description of each parameter follows:</p>
 542
 543 <h5>image</h5>
 544 <p>the image list.</p>
 545
 546 <h5>exception</h5>
 547 <p>return any errors or warnings in this structure.</p>
 548
 549  </div>
 550 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="InsertImageInList">InsertImageInList</a></h2>
 551 <div class="doc-section">
 552
 553 <p>InsertImageInList() insert the given image or image list, into the first image list, immediately AFTER the image pointed to.  The given image list pointer is left unchanged unless previously empty.</p>
 554
 555 <p>The format of the InsertImageInList method is:</p>
 556
 557 <pre class="code">
 558   InsertImageInList(Image **images,Image *insert)
 559 </pre>
 560
 561 <p>A description of each parameter follows:</p>
 562
 563 <h5>images</h5>
 564 <p>the image list to insert into.</p>
 565
 566 <h5>insert</h5>
 567 <p>the image list to insert.</p>
 568
 569  </div>
 570 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="NewImageList">NewImageList</a></h2>
 571 <div class="doc-section">
 572
 573 <p>NewImageList() creates an empty image list.</p>
 574
 575 <p>The format of the NewImageList method is:</p>
 576
 577 <pre class="code">
 578   Image *NewImageList(void)
 579 </pre>
 580
 581  </div>
 582 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="PrependImageToList">PrependImageToList</a></h2>
 583 <div class="doc-section">
 584
 585 <p>PrependImageToList() prepends the image to the beginning of the list.</p>
 586
 587 <p>The format of the PrependImageToList method is:</p>
 588
 589 <pre class="code">
 590   PrependImageToList(Image *images,Image *image)
 591 </pre>
 592
 593 <p>A description of each parameter follows:</p>
 594
 595 <h5>images</h5>
 596 <p>the image list.</p>
 597
 598 <h5>image</h5>
 599 <p>the image.</p>
 600
 601  </div>
 602 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveImageFromList">RemoveImageFromList</a></h2>
 603 <div class="doc-section">
 604
 605 <p>RemoveImageFromList() removes and returns the image pointed to.</p>
 606
 607 <p>The given image list pointer is set to point to the next image in list if it exists, otherwise it is set to the previous image, or NULL if list was emptied.</p>
 608
 609 <p>The format of the RemoveImageFromList method is:</p>
 610
 611 <pre class="code">
 612   Image *RemoveImageFromList(Image **images)
 613 </pre>
 614
 615 <p>A description of each parameter follows:</p>
 616
 617 <h5>images</h5>
 618 <p>the image list.</p>
 619
 620  </div>
 621 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
 622 <div class="doc-section">
 623
 624 <p>RemoveFirstImageFromList() removes and returns the first image in the list.</p>
 625
 626 <p>If the given image list pointer pointed to the removed first image, it is set to the new first image of list, or NULL if list was emptied, otherwise it is left as is.</p>
 627
 628 <p>The format of the RemoveFirstImageFromList method is:</p>
 629
 630 <pre class="code">
 631   Image *RemoveFirstImageFromList(Image **images)
 632 </pre>
 633
 634 <p>A description of each parameter follows:</p>
 635
 636 <h5>images</h5>
 637 <p>the image list.</p>
 638
 639  </div>
 640 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
 641 <div class="doc-section">
 642
 643 <p>RemoveLastImageFromList() removes and returns the last image from the list.</p>
 644
 645 <p>If the given image list pointer pointed to the removed last image, it is set to the new last image of list, or NULL if list was emptied, otherwise it is left as is.</p>
 646
 647 <p>The format of the RemoveLastImageFromList method is:</p>
 648
 649 <pre class="code">
 650   Image *RemoveLastImageFromList(Image **images)
 651 </pre>
 652
 653 <p>A description of each parameter follows:</p>
 654
 655 <h5>images</h5>
 656 <p>the image list.</p>
 657
 658  </div>
 659 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInList">ReplaceImageInList</a></h2>
 660 <div class="doc-section">
 661
 662 <p>ReplaceImageInList() replaces an image in the list with the given image, or list of images.  Old image is destroyed.</p>
 663
 664 <p>The images list pointer is set to point to the first image of the inserted list of images.</p>
 665
 666 <p>The format of the ReplaceImageInList method is:</p>
 667
 668 <pre class="code">
 669   ReplaceImageInList(Image **images,Image *replace)
 670 </pre>
 671
 672 <p>A description of each parameter follows:</p>
 673
 674 <h5>images</h5>
 675 <p>the list and pointer to image to replace</p>
 676
 677 <h5>replace</h5>
 678 <p>the image or image list replacing the original</p>
 679
 680  </div>
 681 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a></h2>
 682 <div class="doc-section">
 683
 684 <p>ReplaceImageInListReturnLast() is exactly as ReplaceImageInList() except the images pointer is set to the last image in the list of replacement images.</p>
 685
 686 <p>This allows you to simply use GetNextImageInList() to go to the image that follows the just replaced image, even if a list of replacement images was inserted.</p>
 687
 688 <p>The format of the ReplaceImageInList method is:</p>
 689
 690 <pre class="code">
 691   ReplaceImageInListReturnLast(Image **images,Image *replace)
 692 </pre>
 693
 694 <p>A description of each parameter follows:</p>
 695
 696 <h5>images</h5>
 697 <p>the list and pointer to image to replace</p>
 698
 699 <h5>replace</h5>
 700 <p>the image or image list replacing the original</p>
 701
 702  </div>
 703 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReverseImageList">ReverseImageList</a></h2>
 704 <div class="doc-section">
 705
 706 <p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p>
 707
 708 <p>The format of the ReverseImageList method is:</p>
 709
 710 <pre class="code">
 711   void ReverseImageList(Image **images)
 712 </pre>
 713
 714 <p>A description of each parameter follows:</p>
 715
 716 <h5>images</h5>
 717 <p>the image list.</p>
 718
 719  </div>
 720 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SpliceImageIntoList">SpliceImageIntoList</a></h2>
 721 <div class="doc-section">
 722
 723 <p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p>
 724
 725 <p>The format of the SpliceImageIntoList method is:</p>
 726
 727 <pre class="code">
 728   SpliceImageIntoList(Image **images,const size_t,
 729     const Image *splice)
 730 </pre>
 731
 732 <p>A description of each parameter follows:</p>
 733
 734 <h5>images</h5>
 735 <p>the image list.</p>
 736
 737 <h5>length</h5>
 738 <p>the length of the image list to remove.</p>
 739
 740 <h5>splice</h5>
 741 <p>Replace the removed image list with this list.</p>
 742
 743  </div>
 744 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SplitImageList">SplitImageList</a></h2>
 745 <div class="doc-section">
 746
 747 <p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p>
 748
 749 <p>The format of the SplitImageList method is:</p>
 750
 751 <pre class="code">
 752   Image *SplitImageList(Image *images)
 753 </pre>
 754
 755 <p>A description of each parameter follows:</p>
 756
 757 <h5>images</h5>
 758 <p>the image list.</p>
 759
 760  </div>
 761
 762 </div>
 763
 764 <div id="linkbar">
 765     <span id="linkbar-west">&nbsp;</span>
 766     <span id="linkbar-center">
 767       <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
 768       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 769     </span>
 770     <span id="linkbar-east">&nbsp;</span>
 771   </div>
 772   <div class="footer">
 773     <span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
 774     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
 775   </div>
 776   <div style="clear: both; margin: 0; width: 100%; "></div>
 777   <script type="text/javascript">
 778     var _gaq = _gaq || [];
 779     _gaq.push(['_setAccount', 'UA-17690367-1']);
 780     _gaq.push(['_trackPageview']);
 781
 782     (function() {
 783       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 784       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 785       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 786     })();
 787   </script>
 788 </body>
 789 </html>