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=viewport content="width=device-width, initial-scale=0.3333334">
  11   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Working with Image Lists</title>
  13   <meta http-equiv="content-language" content="en-US"/>
  14   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="application-name" content="ImageMagick"/>
  17   <meta name="description" content="A collection of tools and libraries to read, write, and manipulate an image in any of the more popular image formats."/>
  18   <meta name="application-url" content="http://www.imagemagick.org"/>
  19   <meta name="generator" content="PHP"/>
  20   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, working, with, image, lists, convert, edit, compose, image, pixel"/>
  21   <meta name="rating" content="GENERAL"/>
  22   <meta name="robots" content="INDEX, FOLLOW"/>
  23   <meta name="generator" content="ImageMagick Studio LLC"/>
  24   <meta name="author" content="ImageMagick Studio LLC"/>
  25   <meta name="revisit-after" content="2 DAYS"/>
  26   <meta name="resource-type" content="document"/>
  27   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
  28   <meta name="distribution" content="Global"/>
  29   <link rel="icon" href="../../images/wand.png"/>
  30   <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
  31   <link rel="canonical" href="http://www.imagemagick.org" />
  32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  33
  34   <!-- Add jQuery library -->
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
  36
  37   <!-- Add mousewheel plugin (this is optional) -->
  38   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
  39
  40   <!-- Add fancyBox -->
  41   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.1.5" type="text/css" media="screen" />
  42   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.1.5"></script>
  43
  44   <!-- Optionally add helpers - button, thumbnail and/or media -->
  45   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.5" type="text/css" media="screen" />
  46   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.5"></script>
  47   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.6"></script>
  48
  49   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=1.0.7" type="text/css" media="screen" />
  50   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=1.0.7"></script>
  51
  52   <script type="text/javascript">
  53         $(document).ready(function() {
  54                 $(".fancybox").fancybox();
  55         });
  56   </script>
  57
  58   <!-- ImageMagick style -->
  59   <style type="text/css" media="all">
  60     @import url("../../www/magick.css");
  61   </style>
  62 </head>
  63
  64 <body id="www-imagemagick-org">
  65
  66 <script type="text/javascript">
  67   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  68   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  69   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  70   })(window,document,'offline-script','//www.google-analytics.com/analytics.js','ga');
  71
  72   ga('create', 'UA-40133312-1', 'imagemagick.org');
  73   ga('send', 'pageview');
  74 </script>
  75
  76 <div class="titlebar">
  77 <div style="margin: 17px auto; float: left;">
  78   <script type="text/javascript">
  79   <!--
  80     google_ad_client = "pub-3129977114552745";
  81     google_ad_slot = "5439289906";
  82     google_ad_width = 728;
  83     google_ad_height = 90;
  84   //-->
  85   </script>
  86   <script type="text/javascript"
  87     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  88   </script>
  89 </div>
  90 <a href="../../discourse-server">
  91   <img src="../../images/logo.jpg"
  92   alt="ImageMagick Logo" width="123" height="118"
  93   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  94 <a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
  95   <img src="../../images/sprite.jpg"
  96   alt="ImageMagick Sprite" width="114" height="118"
  97   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  98 </div>
  99
 100 <div class="westbar">
 101
 102 <div class="menu">
 103   <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
 104 </div>
 105 <div class="menu">
 106   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
 107 </div>
 108 <div class="sub">
 109     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 119 </div>
 120 <div class="sep"></div>
 121 <div class="menu">
 122   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
 123 </div>
 124 <div class="sub">
 125     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 126 </div>
 127 <div class="sub">
 128     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 129 </div>
 130 <div class="sub">
 131     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 132 </div>
 133 <div class="menu">
 134   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 135 </div>
 136 <div class="sub">
 137     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 138 </div>
 139 <div class="sub">
 140     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 141 </div>
 142 <div class="sub">
 143     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 144 </div>
 145 <div class="sub">
 146     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 147 </div>
 148 <div class="sep"></div>
 149 <div  class="menu">
 150    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 151 </div>
 152 <div class="sub">
 153     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 154 </div>
 155 <div class="sub">
 156     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 157  </div>
 158 <div class="menu">
 159   <a title="Resources" href="../../www/resources.html">Resources</a>
 160 </div>
 161 <div class="menu">
 162   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 163 </div>
 164 <div class="menu">
 165   <a title="Download" href="../../www/download.html">Download</a>
 166 </div>
 167 <div class="sep"></div>
 168 <div class="menu">
 169   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 170 </div>
 171 <div class="sep"></div>
 172 <div class="menu">
 173   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 174 </div>
 175 <div  class="sub">
 176   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 177 </div>
 178 <div class="sep"></div>
 179 </div>
 180
 181 <div class="eastbar">
 182   <script type="text/javascript">
 183     /* <![CDATA[ */
 184     window.___gcfg = {
 185       lang: 'en-US'
 186     };
 187
 188     (function() {
 189       var po = document.createElement('offline-script');
 190       po.type = 'text/javascript';
 191       po.async = true;
 192       po.src = 'https://apis.google.com/js/plusone.js';
 193       var script = document.getElementsByTagName('offline-script')[0];
 194       script.parentNode.insertBefore(po, script);
 195     })();
 196     var gplusone = document.getElementById("gplusone");
 197     gplusone.setAttribute("data-size","medium");
 198     gplusone.setAttribute("data-count","true");
 199     /* ]]> */
 200   </script>
 201   <script type="text/javascript">
 202     /* <![CDATA[ */
 203     (function() {
 204         var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
 205         po.type = 'text/javascript';
 206         po.async = true;
 207         po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
 208         var script = document.getElementsByTagName('offline-script')[0];
 209         script.parentNode.insertBefore(po, script);
 210     })();
 211     /* ]]> */
 212   </script>
 213   <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
 214   <noscript>
 215     <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
 216     <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
 217   </noscript>
 218   <div class="g-plusone" data-size="standard" data-count="true"></div>
 219 </div>
 220
 221 <div class="main">
 222
 223 <h1>Module list Methods</h1>
 224 <p class="navigation-index">[<a href="list.html#AppendImageToList">AppendImageToList</a> &#8226; <a href="list.html#CloneImageList">CloneImageList</a> &#8226; <a href="list.html#CloneImages">CloneImages</a> &#8226; <a href="list.html#DeleteImageFromList">DeleteImageFromList</a> &#8226; <a href="list.html#DeleteImages">DeleteImages</a> &#8226; <a href="list.html#DestroyImageList">DestroyImageList</a> &#8226; <a href="list.html#DuplicateImages">DuplicateImages</a> &#8226; <a href="list.html#GetFirstImageInList">GetFirstImageInList</a> &#8226; <a href="list.html#GetImageFromList">GetImageFromList</a> &#8226; <a href="list.html#GetImageIndexInList">GetImageIndexInList</a> &#8226; <a href="list.html#GetImageListLength">GetImageListLength</a> &#8226; <a href="list.html#GetLastImageInList">GetLastImageInList</a> &#8226; <a href="list.html#GetNextImageInList">GetNextImageInList</a> &#8226; <a href="list.html#GetPreviousImageInList">GetPreviousImageInList</a> &#8226; <a href="list.html#ImageListToArray">ImageListToArray</a> &#8226; <a href="list.html#InsertImageInList">InsertImageInList</a> &#8226; <a href="list.html#NewImageList">NewImageList</a> &#8226; <a href="list.html#PrependImageToList">PrependImageToList</a> &#8226; <a href="list.html#RemoveImageFromList">RemoveImageFromList</a> &#8226; <a href="list.html#RemoveFirstImageFromList">RemoveFirstImageFromList</a> &#8226; <a href="list.html#RemoveLastImageFromList">RemoveLastImageFromList</a> &#8226; <a href="list.html#ReplaceImageInList">ReplaceImageInList</a> &#8226; <a href="list.html#ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a> &#8226; <a href="list.html#ReverseImageList">ReverseImageList</a> &#8226; <a href="list.html#SpliceImageIntoList">SpliceImageIntoList</a> &#8226; <a href="list.html#SplitImageList">SplitImageList</a>]</p>
 225
 226 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="AppendImageToList">AppendImageToList</a></h2>
 227 <div class="doc-section">
 228
 229 <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>
 230
 231 <p>The format of the AppendImageToList method is:</p>
 232
 233 <pre class="code">
 234   AppendImageToList(Image *images,const Image *image)
 235 </pre>
 236
 237 <p>A description of each parameter follows:</p>
 238
 239 <h5>images</h5>
 240 <p>the image list to be appended to.</p>
 241
 242 <h5>image</h5>
 243 <p>the appended image or image list.</p>
 244
 245  </div>
 246 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImageList">CloneImageList</a></h2>
 247 <div class="doc-section">
 248
 249 <p>CloneImageList() returns a duplicate of the image list.</p>
 250
 251 <p>The format of the CloneImageList method is:</p>
 252
 253 <pre class="code">
 254   Image *CloneImageList(const Image *images,ExceptionInfo *exception)
 255 </pre>
 256
 257 <p>A description of each parameter follows:</p>
 258
 259 <h5>images</h5>
 260 <p>the image list.</p>
 261
 262 <h5>exception</h5>
 263 <p>return any errors or warnings in this structure.</p>
 264
 265  </div>
 266 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImages">CloneImages</a></h2>
 267 <div class="doc-section">
 268
 269 <p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
 270
 271 <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>
 272
 273 <p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p>
 274
 275 <p>The format of the CloneImages method is:</p>
 276
 277 <pre class="code">
 278   Image *CloneImages(const Image *images,const char *scenes,
 279     ExceptionInfo *exception)
 280 </pre>
 281
 282 <p>A description of each parameter follows:</p>
 283
 284 <h5>images</h5>
 285 <p>the image sequence.</p>
 286
 287 <h5>scenes</h5>
 288 <p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p>
 289
 290 <h5>exception</h5>
 291 <p>return any errors or warnings in this structure.</p>
 292
 293  </div>
 294 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImageFromList">DeleteImageFromList</a></h2>
 295 <div class="doc-section">
 296
 297 <p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p>
 298
 299 <p>The format of the DeleteImageFromList method is:</p>
 300
 301 <pre class="code">
 302   DeleteImageFromList(Image **images)
 303 </pre>
 304
 305 <p>A description of each parameter follows:</p>
 306
 307 <h5>images</h5>
 308 <p>the image list.</p>
 309
 310  </div>
 311 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImages">DeleteImages</a></h2>
 312 <div class="doc-section">
 313
 314 <p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
 315
 316 <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>
 317
 318 <p>If the referenced images are in the reverse order, that range will be completely ignored, unlike CloneImages().</p>
 319
 320 <p>The format of the DeleteImages method is:</p>
 321
 322 <pre class="code">
 323   DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
 324 </pre>
 325
 326 <p>A description of each parameter follows:</p>
 327
 328 <h5>images</h5>
 329 <p>the image sequence.</p>
 330
 331 <h5>scenes</h5>
 332 <p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p>
 333
 334 <h5>exception</h5>
 335 <p>return any errors or warnings in this structure.</p>
 336
 337  </div>
 338 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DestroyImageList">DestroyImageList</a></h2>
 339 <div class="doc-section">
 340
 341 <p>DestroyImageList() destroys an image list.</p>
 342
 343 <p>The format of the DestroyImageList method is:</p>
 344
 345 <pre class="code">
 346   Image *DestroyImageList(Image *image)
 347 </pre>
 348
 349 <p>A description of each parameter follows:</p>
 350
 351 <h5>image</h5>
 352 <p>the image sequence.</p>
 353
 354  </div>
 355 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DuplicateImages">DuplicateImages</a></h2>
 356 <div class="doc-section">
 357
 358 <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>
 359
 360 <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>
 361
 362 <p>The format of the DuplicateImages method is:</p>
 363
 364 <pre class="code">
 365   Image *DuplicateImages(Image *images,const size_t number_duplicates,
 366     const char *scenes,ExceptionInfo *exception)
 367 </pre>
 368
 369 <p>A description of each parameter follows:</p>
 370
 371 <h5>images</h5>
 372 <p>the image sequence.</p>
 373
 374 <h5>number_duplicates</h5>
 375 <p>duplicate the image sequence this number of times.</p>
 376
 377 <h5>scenes</h5>
 378 <p>This character string specifies which scenes to duplicate (e.g. 1,3-5,-2-6,2).</p>
 379
 380 <h5>exception</h5>
 381 <p>return any errors or warnings in this structure.</p>
 382
 383  </div>
 384 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetFirstImageInList">GetFirstImageInList</a></h2>
 385 <div class="doc-section">
 386
 387 <p>GetFirstImageInList() returns a pointer to the first image in the list.</p>
 388
 389 <p>The format of the GetFirstImageInList method is:</p>
 390
 391 <pre class="code">
 392   Image *GetFirstImageInList(const Image *images)
 393 </pre>
 394
 395 <p>A description of each parameter follows:</p>
 396
 397 <h5>images</h5>
 398 <p>the image list.</p>
 399
 400  </div>
 401 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageFromList">GetImageFromList</a></h2>
 402 <div class="doc-section">
 403
 404 <p>GetImageFromList() returns an image at the specified index from the image list. Starting with 0 as the first image in the list.</p>
 405
 406 <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>
 407
 408 <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>
 409
 410 <p>The format of the GetImageFromList method is:</p>
 411
 412 <pre class="code">
 413   Image *GetImageFromList(const Image *images,const ssize_t index)
 414 </pre>
 415
 416 <p>A description of each parameter follows:</p>
 417
 418 <h5>images</h5>
 419 <p>the image list.</p>
 420
 421 <h5>index</h5>
 422 <p>the position within the list.</p>
 423
 424  </div>
 425 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageIndexInList">GetImageIndexInList</a></h2>
 426 <div class="doc-section">
 427
 428 <p>GetImageIndexInList() returns the offset in the list of the specified image.</p>
 429
 430 <p>The format of the GetImageIndexInList method is:</p>
 431
 432 <pre class="code">
 433   ssize_t GetImageIndexInList(const Image *images)
 434 </pre>
 435
 436 <p>A description of each parameter follows:</p>
 437
 438 <h5>images</h5>
 439 <p>the image list.</p>
 440
 441  </div>
 442 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageListLength">GetImageListLength</a></h2>
 443 <div class="doc-section">
 444
 445 <p>GetImageListLength() returns the length of the list (the number of images in the list).</p>
 446
 447 <p>The format of the GetImageListLength method is:</p>
 448
 449 <pre class="code">
 450   size_t GetImageListLength(const Image *images)
 451 </pre>
 452
 453 <p>A description of each parameter follows:</p>
 454
 455 <h5>images</h5>
 456 <p>the image list.</p>
 457
 458  </div>
 459 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetLastImageInList">GetLastImageInList</a></h2>
 460 <div class="doc-section">
 461
 462 <p>GetLastImageInList() returns a pointer to the last image in the list.</p>
 463
 464 <p>The format of the GetLastImageInList method is:</p>
 465
 466 <pre class="code">
 467   Image *GetLastImageInList(const Image *images)
 468 </pre>
 469
 470 <p>A description of each parameter follows:</p>
 471
 472 <h5>images</h5>
 473 <p>the image list.</p>
 474
 475  </div>
 476 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetNextImageInList">GetNextImageInList</a></h2>
 477 <div class="doc-section">
 478
 479 <p>GetNextImageInList() returns the next image in the list.</p>
 480
 481 <p>The format of the GetNextImageInList method is:</p>
 482
 483 <pre class="code">
 484   Image *GetNextImageInList(const Image *images)
 485 </pre>
 486
 487 <p>A description of each parameter follows:</p>
 488
 489 <h5>images</h5>
 490 <p>the image list.</p>
 491
 492  </div>
 493 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetPreviousImageInList">GetPreviousImageInList</a></h2>
 494 <div class="doc-section">
 495
 496 <p>GetPreviousImageInList() returns the previous image in the list.</p>
 497
 498 <p>The format of the GetPreviousImageInList method is:</p>
 499
 500 <pre class="code">
 501   Image *GetPreviousImageInList(const Image *images)
 502 </pre>
 503
 504 <p>A description of each parameter follows:</p>
 505
 506 <h5>images</h5>
 507 <p>the image list.</p>
 508
 509  </div>
 510 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ImageListToArray">ImageListToArray</a></h2>
 511 <div class="doc-section">
 512
 513 <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>
 514
 515 <p>The images remain part of the original image list, with the array providing an alternative means of indexing the image array.</p>
 516
 517 <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>
 518
 519 <p>The format of the ImageListToArray method is:</p>
 520
 521 <pre class="code">
 522   Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
 523 </pre>
 524
 525 <p>A description of each parameter follows:</p>
 526
 527 <h5>image</h5>
 528 <p>the image list.</p>
 529
 530 <h5>exception</h5>
 531 <p>return any errors or warnings in this structure.</p>
 532
 533  </div>
 534 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="InsertImageInList">InsertImageInList</a></h2>
 535 <div class="doc-section">
 536
 537 <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>
 538
 539 <p>The format of the InsertImageInList method is:</p>
 540
 541 <pre class="code">
 542   InsertImageInList(Image **images,Image *insert)
 543 </pre>
 544
 545 <p>A description of each parameter follows:</p>
 546
 547 <h5>images</h5>
 548 <p>the image list to insert into.</p>
 549
 550 <h5>insert</h5>
 551 <p>the image list to insert.</p>
 552
 553  </div>
 554 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="NewImageList">NewImageList</a></h2>
 555 <div class="doc-section">
 556
 557 <p>NewImageList() creates an empty image list.</p>
 558
 559 <p>The format of the NewImageList method is:</p>
 560
 561 <pre class="code">
 562   Image *NewImageList(void)
 563 </pre>
 564
 565  </div>
 566 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="PrependImageToList">PrependImageToList</a></h2>
 567 <div class="doc-section">
 568
 569 <p>PrependImageToList() prepends the image to the beginning of the list.</p>
 570
 571 <p>The format of the PrependImageToList method is:</p>
 572
 573 <pre class="code">
 574   PrependImageToList(Image *images,Image *image)
 575 </pre>
 576
 577 <p>A description of each parameter follows:</p>
 578
 579 <h5>images</h5>
 580 <p>the image list.</p>
 581
 582 <h5>image</h5>
 583 <p>the image.</p>
 584
 585  </div>
 586 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveImageFromList">RemoveImageFromList</a></h2>
 587 <div class="doc-section">
 588
 589 <p>RemoveImageFromList() removes and returns the image pointed to.</p>
 590
 591 <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>
 592
 593 <p>The format of the RemoveImageFromList method is:</p>
 594
 595 <pre class="code">
 596   Image *RemoveImageFromList(Image **images)
 597 </pre>
 598
 599 <p>A description of each parameter follows:</p>
 600
 601 <h5>images</h5>
 602 <p>the image list.</p>
 603
 604  </div>
 605 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
 606 <div class="doc-section">
 607
 608 <p>RemoveFirstImageFromList() removes and returns the first image in the list.</p>
 609
 610 <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>
 611
 612 <p>The format of the RemoveFirstImageFromList method is:</p>
 613
 614 <pre class="code">
 615   Image *RemoveFirstImageFromList(Image **images)
 616 </pre>
 617
 618 <p>A description of each parameter follows:</p>
 619
 620 <h5>images</h5>
 621 <p>the image list.</p>
 622
 623  </div>
 624 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
 625 <div class="doc-section">
 626
 627 <p>RemoveLastImageFromList() removes and returns the last image from the list.</p>
 628
 629 <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>
 630
 631 <p>The format of the RemoveLastImageFromList method is:</p>
 632
 633 <pre class="code">
 634   Image *RemoveLastImageFromList(Image **images)
 635 </pre>
 636
 637 <p>A description of each parameter follows:</p>
 638
 639 <h5>images</h5>
 640 <p>the image list.</p>
 641
 642  </div>
 643 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInList">ReplaceImageInList</a></h2>
 644 <div class="doc-section">
 645
 646 <p>ReplaceImageInList() replaces an image in the list with the given image, or list of images.  Old image is destroyed.</p>
 647
 648 <p>The images list pointer is set to point to the first image of the inserted list of images.</p>
 649
 650 <p>The format of the ReplaceImageInList method is:</p>
 651
 652 <pre class="code">
 653   ReplaceImageInList(Image **images,Image *replace)
 654 </pre>
 655
 656 <p>A description of each parameter follows:</p>
 657
 658 <h5>images</h5>
 659 <p>the list and pointer to image to replace</p>
 660
 661 <h5>replace</h5>
 662 <p>the image or image list replacing the original</p>
 663
 664  </div>
 665 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a></h2>
 666 <div class="doc-section">
 667
 668 <p>ReplaceImageInListReturnLast() is exactly as ReplaceImageInList() except the images pointer is set to the last image in the list of replacement images.</p>
 669
 670 <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>
 671
 672 <p>The format of the ReplaceImageInList method is:</p>
 673
 674 <pre class="code">
 675   ReplaceImageInListReturnLast(Image **images,Image *replace)
 676 </pre>
 677
 678 <p>A description of each parameter follows:</p>
 679
 680 <h5>images</h5>
 681 <p>the list and pointer to image to replace</p>
 682
 683 <h5>replace</h5>
 684 <p>the image or image list replacing the original</p>
 685
 686  </div>
 687 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReverseImageList">ReverseImageList</a></h2>
 688 <div class="doc-section">
 689
 690 <p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p>
 691
 692 <p>The format of the ReverseImageList method is:</p>
 693
 694 <pre class="code">
 695   void ReverseImageList(Image **images)
 696 </pre>
 697
 698 <p>A description of each parameter follows:</p>
 699
 700 <h5>images</h5>
 701 <p>the image list.</p>
 702
 703  </div>
 704 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SpliceImageIntoList">SpliceImageIntoList</a></h2>
 705 <div class="doc-section">
 706
 707 <p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p>
 708
 709 <p>The format of the SpliceImageIntoList method is:</p>
 710
 711 <pre class="code">
 712   SpliceImageIntoList(Image **images,const size_t,
 713     const Image *splice)
 714 </pre>
 715
 716 <p>A description of each parameter follows:</p>
 717
 718 <h5>images</h5>
 719 <p>the image list.</p>
 720
 721 <h5>length</h5>
 722 <p>the length of the image list to remove.</p>
 723
 724 <h5>splice</h5>
 725 <p>Replace the removed image list with this list.</p>
 726
 727  </div>
 728 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SplitImageList">SplitImageList</a></h2>
 729 <div class="doc-section">
 730
 731 <p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p>
 732
 733 <p>The format of the SplitImageList method is:</p>
 734
 735 <pre class="code">
 736   Image *SplitImageList(Image *images)
 737 </pre>
 738
 739 <p>A description of each parameter follows:</p>
 740
 741 <h5>images</h5>
 742 <p>the image list.</p>
 743
 744  </div>
 745
 746 </div>
 747
 748 <div id="linkbar">
 749     <span id="linkbar-west"> </span>
 750
 751     <span id="linkbar-center">
 752       <a href="../../discourse-server">Discourse Server</a> •
 753       <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 754       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
 755       <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
 756     </span>
 757     <span id="linkbar-east"> </span>
 758 </div>
 759 <div class="footer">
 760   <span id="footer-west">©  1999-2014 ImageMagick Studio LLC</span>
 761   <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
 762 </div>
 763 <div style="clear: both; margin: 0; width: 100%; "></div>
 764 </body>
 765 </html>