1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
\r
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
\r
3 <html version="-//W3C//DTD XHTML 1.1//EN"
\r
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
\r
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
\r
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
\r
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
\r
9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
\r
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
\r
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."/>
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, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
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-2011 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="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
\r
31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
\r
32 <style type="text/css" media="all">
\r
33 @import url("../../www/magick.css");
\r
35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
\r
36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
\r
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
\r
38 <script type="text/javascript">
\r
39 $(document).ready(function() {
\r
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
\r
41 'transitionIn' : 'elastic',
\r
42 'transitionOut' : 'elastic',
\r
43 'overlayShow' : false,
\r
50 <body id="www-imagemagick-org">
\r
51 <div class="titlebar">
\r
52 <a href="../../index.html">
\r
53 <img src="../../images/script.png" alt="[ImageMagick]"
\r
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
55 <a href="http://www.networkredux.com">
\r
56 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
57 style="margin-top: 42px; border: 0px; float: left;" /></a>
\r
58 <a href="http://www.imagemagick.org/discourse-server/">
\r
59 <img src="../../images/logo.jpg"
\r
60 alt="ImageMagick Logo"
\r
61 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
\r
62 <a href="../../index.html">
\r
63 <img src="../../images/sprite.jpg"
\r
64 alt="ImageMagick Sprite"
\r
65 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
68 <div class="westbar">
\r
71 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
73 <div class="sep"></div>
\r
75 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
84 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
87 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
89 <div class="sep"></div>
\r
91 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
94 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
97 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
100 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
103 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
106 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
109 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
112 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
115 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
117 <div class="sep"></div>
\r
119 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
122 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
125 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
128 <a title="Resources" href="../../www/resources.html">Resources</a>
131 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
134 <a title="Download" href="../../www/download.html">Download</a>
136 <div class="sep"></div>
\r
138 <a title="Search" href="../../www/search.html">Search</a>
140 <div class="sep"></div>
\r
142 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
145 <a title="Site Map: Links" href="../../www/links.html">Links</a>
147 <div class="sep"></div>
\r
149 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
151 <div class="sponsbox">
152 <div class="sponsor">
153 <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
155 <div class="sponsor">
156 <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
158 <div class="sponsor">
159 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
161 <div class="sponsor">
162 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
164 <div class="sponsor">
165 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
167 <div class="sponsor">
168 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
170 <div class="sponsor">
171 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
173 <div class="sponsor">
174 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
176 <div class="sponsor">
177 <a title="Sponsor: Fototapete" href=" http://www.allesdruck.de/Fototapete-Tapetendruck,category,8830.html">Fototapete</a><!-- 20110701000080 a-o.de -->
183 <div class="eastbar">
\r
184 <script type="text/javascript">
\r
186 google_ad_client = "pub-3129977114552745";
\r
187 google_ad_slot = "0574824969";
\r
188 google_ad_width = 160;
\r
189 google_ad_height = 600;
\r
192 <script type="text/javascript"
\r
193 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
199 <h1>Module list Methods</h1>
200 <p class="navigation-index">[<a href="#AppendImageToList">AppendImageToList</a> • <a href="#CloneImageList">CloneImageList</a> • <a href="#CloneImages">CloneImages</a> • <a href="#DeleteImageFromList">DeleteImageFromList</a> • <a href="#DeleteImages">DeleteImages</a> • <a href="#DestroyImageList">DestroyImageList</a> • <a href="#GetFirstImageInList">GetFirstImageInList</a> • <a href="#GetImageFromList">GetImageFromList</a> • <a href="#GetImageIndexInList">GetImageIndexInList</a> • <a href="#GetImageListLength">GetImageListLength</a> • <a href="#GetLastImageInList">GetLastImageInList</a> • <a href="#GetNextImageInList">GetNextImageInList</a> • <a href="#GetPreviousImageInList">GetPreviousImageInList</a> • <a href="#ImageListToArray">ImageListToArray</a> • <a href="#InsertImageInList">InsertImageInList</a> • <a href="#NewImageList">NewImageList</a> • <a href="#PrependImageToList">PrependImageToList</a> • <a href="#RemoveImageFromList">RemoveImageFromList</a> • <a href="#RemoveFirstImageFromList">RemoveFirstImageFromList</a> • <a href="#RemoveLastImageFromList">RemoveLastImageFromList</a> • <a href="#ReplaceImageInList">ReplaceImageInList</a> • <a href="#ReverseImageList">ReverseImageList</a> • <a href="#SpliceImageIntoList">SpliceImageIntoList</a> • <a href="#SplitImageList">SplitImageList</a>]</p>
202 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="AppendImageToList">AppendImageToList</a></h2>
203 <div class="doc-section">
205 <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>
207 <p>The format of the AppendImageToList method is:</p>
210 AppendImageToList(Image *images,const Image *image)
213 <p>A description of each parameter follows:</p>
216 <p>the image list to be appended to.</p>
219 <p>the appended image or image list.</p>
222 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImageList">CloneImageList</a></h2>
223 <div class="doc-section">
225 <p>CloneImageList() returns a duplicate of the image list.</p>
227 <p>The format of the CloneImageList method is:</p>
230 Image *CloneImageList(const Image *images,ExceptionInfo *exception)
233 <p>A description of each parameter follows:</p>
236 <p>the image list.</p>
239 <p>return any errors or warnings in this structure.</p>
242 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImages">CloneImages</a></h2>
243 <div class="doc-section">
245 <p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
247 <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>
249 <p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p>
251 <p>The format of the CloneImages method is:</p>
254 Image *CloneImages(const Image *images,const char *scenes,
255 ExceptionInfo *exception)
258 <p>A description of each parameter follows:</p>
261 <p>the image sequence.</p>
264 <p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p>
267 <p>return any errors or warnings in this structure.</p>
270 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImageFromList">DeleteImageFromList</a></h2>
271 <div class="doc-section">
273 <p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p>
275 <p>The format of the DeleteImageFromList method is:</p>
278 DeleteImageFromList(Image **images)
281 <p>A description of each parameter follows:</p>
284 <p>the image list.</p>
287 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImages">DeleteImages</a></h2>
288 <div class="doc-section">
290 <p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
292 <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>
294 <p>If the referenced images are in the reverse order, that range will be completely ignored. Unlike CloneImages().</p>
296 <p>The format of the DeleteImages method is:</p>
299 DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
302 <p>A description of each parameter follows:</p>
305 <p>the image sequence.</p>
308 <p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p>
311 <p>return any errors or warnings in this structure.</p>
314 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DestroyImageList">DestroyImageList</a></h2>
315 <div class="doc-section">
317 <p>DestroyImageList() destroys an image list.</p>
319 <p>The format of the DestroyImageList method is:</p>
322 Image *DestroyImageList(Image *image)
325 <p>A description of each parameter follows:</p>
328 <p>the image sequence.</p>
331 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetFirstImageInList">GetFirstImageInList</a></h2>
332 <div class="doc-section">
334 <p>GetFirstImageInList() returns a pointer to the first image in the list.</p>
336 <p>The format of the GetFirstImageInList method is:</p>
339 Image *GetFirstImageInList(const Image *images)
342 <p>A description of each parameter follows:</p>
345 <p>the image list.</p>
348 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageFromList">GetImageFromList</a></h2>
349 <div class="doc-section">
351 <p>GetImageFromList() returns an image at the specified offset from the list.</p>
353 <p>The format of the GetImageFromList method is:</p>
356 Image *GetImageFromList(const Image *images,const ssize_t index)
359 <p>A description of each parameter follows:</p>
362 <p>the image list.</p>
365 <p>the position within the list.</p>
368 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageIndexInList">GetImageIndexInList</a></h2>
369 <div class="doc-section">
371 <p>GetImageIndexInList() returns the offset in the list of the specified image.</p>
373 <p>The format of the GetImageIndexInList method is:</p>
376 ssize_t GetImageIndexInList(const Image *images)
379 <p>A description of each parameter follows:</p>
382 <p>the image list.</p>
385 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageListLength">GetImageListLength</a></h2>
386 <div class="doc-section">
388 <p>GetImageListLength() returns the length of the list (the number of images in the list).</p>
390 <p>The format of the GetImageListLength method is:</p>
393 size_t GetImageListLength(const Image *images)
396 <p>A description of each parameter follows:</p>
399 <p>the image list.</p>
402 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetLastImageInList">GetLastImageInList</a></h2>
403 <div class="doc-section">
405 <p>GetLastImageInList() returns a pointer to the last image in the list.</p>
407 <p>The format of the GetLastImageInList method is:</p>
410 Image *GetLastImageInList(const Image *images)
413 <p>A description of each parameter follows:</p>
416 <p>the image list.</p>
419 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetNextImageInList">GetNextImageInList</a></h2>
420 <div class="doc-section">
422 <p>GetNextImageInList() returns the next image in the list.</p>
424 <p>The format of the GetNextImageInList method is:</p>
427 Image *GetNextImageInList(const Image *images)
430 <p>A description of each parameter follows:</p>
433 <p>the image list.</p>
436 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetPreviousImageInList">GetPreviousImageInList</a></h2>
437 <div class="doc-section">
439 <p>GetPreviousImageInList() returns the previous image in the list.</p>
441 <p>The format of the GetPreviousImageInList method is:</p>
444 Image *GetPreviousImageInList(const Image *images)
447 <p>A description of each parameter follows:</p>
450 <p>the image list.</p>
453 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ImageListToArray">ImageListToArray</a></h2>
454 <div class="doc-section">
456 <p>ImageListToArray() is a convenience method that converts an image list to a sequential array. For example,</p>
458 <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>
460 <p>The format of the ImageListToArray method is:</p>
463 Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
466 <p>A description of each parameter follows:</p>
469 <p>the image list.</p>
472 <p>return any errors or warnings in this structure.</p>
475 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="InsertImageInList">InsertImageInList</a></h2>
476 <div class="doc-section">
478 <p>InsertImageInList() inserts the second image or image list into the first image list immediately after the image pointed to. The given image list pointer is unchanged unless previously empty.</p>
480 <p>The format of the InsertImageInList method is:</p>
483 InsertImageInList(Image **images,Image *image)
486 <p>A description of each parameter follows:</p>
489 <p>the image list to insert into.</p>
492 <p>the image list to insert.</p>
495 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="NewImageList">NewImageList</a></h2>
496 <div class="doc-section">
498 <p>NewImageList() creates an empty image list.</p>
500 <p>The format of the NewImageList method is:</p>
503 Image *NewImageList(void)
507 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="PrependImageToList">PrependImageToList</a></h2>
508 <div class="doc-section">
510 <p>PrependImageToList() prepends the image to the beginning of the list.</p>
512 <p>The format of the PrependImageToList method is:</p>
515 PrependImageToList(Image *images,Image *image)
518 <p>A description of each parameter follows:</p>
521 <p>the image list.</p>
527 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveImageFromList">RemoveImageFromList</a></h2>
528 <div class="doc-section">
530 <p>RemoveImageFromList() removes and returns the image pointed to.</p>
532 <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>
534 <p>The format of the RemoveImageFromList method is:</p>
537 Image *RemoveImageFromList(Image **images)
540 <p>A description of each parameter follows:</p>
543 <p>the image list.</p>
546 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
547 <div class="doc-section">
549 <p>RemoveFirstImageFromList() removes and returns the first image in the list.</p>
551 <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>
553 <p>The format of the RemoveFirstImageFromList method is:</p>
556 Image *RemoveFirstImageFromList(Image **images)
559 <p>A description of each parameter follows:</p>
562 <p>the image list.</p>
565 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
566 <div class="doc-section">
568 <p>RemoveLastImageFromList() removes and returns the last image from the list.</p>
570 <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>
572 <p>The format of the RemoveLastImageFromList method is:</p>
575 Image *RemoveLastImageFromList(Image **images)
578 <p>A description of each parameter follows:</p>
581 <p>the image list.</p>
584 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInList">ReplaceImageInList</a></h2>
585 <div class="doc-section">
587 <p>ReplaceImageInList() replaces an image in the list. Old image is destroyed. The given image list pointer is set to point to the just inserted image.</p>
589 <p>The format of the ReplaceImageInList method is:</p>
592 ReplaceImageInList(Image **images,Image *image)
595 <p>A description of each parameter follows:</p>
598 <p>the image list.</p>
604 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReverseImageList">ReverseImageList</a></h2>
605 <div class="doc-section">
607 <p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p>
609 <p>The format of the ReverseImageList method is:</p>
612 void ReverseImageList(Image **images)
615 <p>A description of each parameter follows:</p>
618 <p>the image list.</p>
621 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SpliceImageIntoList">SpliceImageIntoList</a></h2>
622 <div class="doc-section">
624 <p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p>
626 <p>The format of the SpliceImageIntoList method is:</p>
629 SpliceImageIntoList(Image **images,const size_t,
633 <p>A description of each parameter follows:</p>
636 <p>the image list.</p>
639 <p>the length of the image list to remove.</p>
642 <p>Replace the removed image list with this list.</p>
645 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SplitImageList">SplitImageList</a></h2>
646 <div class="doc-section">
648 <p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p>
650 <p>The format of the SplitImageList method is:</p>
653 Image *SplitImageList(Image *images)
656 <p>A description of each parameter follows:</p>
659 <p>the image list.</p>
666 <span id="linkbar-west"> </span>
\r
667 <span id="linkbar-center">
\r
668 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
669 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
671 <span id="linkbar-east"> </span>
\r
673 <div class="footer">
\r
674 <span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span>
\r
675 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
677 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
678 <script type="text/javascript">
\r
679 var _gaq = _gaq || [];
\r
680 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
681 _gaq.push(['_trackPageview']);
\r
684 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
685 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
686 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r