Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 61365ada1c2d01a07de367026920651d0d1ce3ec / . / www / api / list.html
blob: b05733a8ee7668b2922a05851c2851354d3e202a [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
7 <title>ImageMagick: MagickCore, C API for ImageMagick: Working with Image Lists</title/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
12 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristy61365ad2010-11-28 02:38:34 +0000[diff] [blame^]130 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170<p class="navigation-index">[<a href="#AppendImageToList">AppendImageToList</a> &bull; <a href="#CloneImageList">CloneImageList</a> &bull; <a href="#CloneImages">CloneImages</a> &bull; <a href="#DeleteImageFromList">DeleteImageFromList</a> &bull; <a href="#DeleteImages">DeleteImages</a> &bull; <a href="#DestroyImageList">DestroyImageList</a> &bull; <a href="#GetFirstImageInList">GetFirstImageInList</a> &bull; <a href="#GetImageFromList">GetImageFromList</a> &bull; <a href="#GetImageIndexInList">GetImageIndexInList</a> &bull; <a href="#GetImageListLength">GetImageListLength</a> &bull; <a href="#GetLastImageInList">GetLastImageInList</a> &bull; <a href="#GetNextImageInList">GetNextImageInList</a> &bull; <a href="#GetPreviousImageInList">GetPreviousImageInList</a> &bull; <a href="#ImageListToArray">ImageListToArray</a> &bull; <a href="#InsertImageInList">InsertImageInList</a> &bull; <a href="#NewImageList">NewImageList</a> &bull; <a href="#PrependImageToList">PrependImageToList</a> &bull; <a href="#RemoveImageFromList">RemoveImageFromList</a> &bull; <a href="#RemoveFirstImageFromList">RemoveFirstImageFromList</a> &bull; <a href="#RemoveLastImageFromList">RemoveLastImageFromList</a> &bull; <a href="#ReplaceImageInList">ReplaceImageInList</a> &bull; <a href="#ReverseImageList">ReverseImageList</a> &bull; <a href="#SpliceImageIntoList">SpliceImageIntoList</a> &bull; <a href="#SplitImageList">SplitImageList</a>]</p>
171
172<h2><a href="http://www.imagemagick.org/api/MagickCore/list
173_8c.html" target="source" name="AppendImageToList">AppendImageToList</a></h2>
174<div class="doc-section">
175
176<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></ol>
177
178<p>The format of the AppendImageToList method is:</p>
179
180<pre class="code">
181 AppendImageToList(Image *images,const Image *image)
182</pre>
183
184<p>A description of each parameter follows:</p></ol>
185
186<h5>images</h5>
187<ol><p>the image list to be appended to.</p></ol>
188
189<h5>image</h5>
190<ol><p>the appended image or image list.</p></ol>
191
192 </div>
193<h2><a href="http://www.imagemagick.org/api/MagickCore/list
194_8c.html" target="source" name="CloneImageList">CloneImageList</a></h2>
195<div class="doc-section">
196
197<p>CloneImageList() returns a duplicate of the image list.</p></ol>
198
199<p>The format of the CloneImageList method is:</p>
200
201<pre class="code">
202 Image *CloneImageList(const Image *images,ExceptionInfo *exception)
203</pre>
204
205<p>A description of each parameter follows:</p></ol>
206
207<h5>images</h5>
208<ol><p>the image list.</p></ol>
209
210<h5>exception</h5>
211<ol><p>return any errors or warnings in this structure.</p></ol>
212
213 </div>
214<h2><a href="http://www.imagemagick.org/api/MagickCore/list
215_8c.html" target="source" name="CloneImages">CloneImages</a></h2>
216<div class="doc-section">
217
218<p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p></ol>
219
220<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></ol>
221
222<p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p></ol>
223
224<p>The format of the CloneImages method is:</p>
225
226<pre class="code">
227 Image *CloneImages(const Image *images,const char *scenes,
228 ExceptionInfo *exception)
229</pre>
230
231<p>A description of each parameter follows:</p></ol>
232
233<h5>images</h5>
234<ol><p>the image sequence.</p></ol>
235
236<h5>scenes</h5>
237<ol><p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p></ol>
238
239<h5>exception</h5>
240<ol><p>return any errors or warnings in this structure.</p></ol>
241
242 </div>
243<h2><a href="http://www.imagemagick.org/api/MagickCore/list
244_8c.html" target="source" name="DeleteImageFromList">DeleteImageFromList</a></h2>
245<div class="doc-section">
246
247<p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p></ol>
248
249<p>The format of the DeleteImageFromList method is:</p>
250
251<pre class="code">
252 DeleteImageFromList(Image **images)
253</pre>
254
255<p>A description of each parameter follows:</p></ol>
256
257<h5>images</h5>
258<ol><p>the image list.</p></ol>
259
260 </div>
261<h2><a href="http://www.imagemagick.org/api/MagickCore/list
262_8c.html" target="source" name="DeleteImages">DeleteImages</a></h2>
263<div class="doc-section">
264
265<p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p></ol>
266
267<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></ol>
268
269<p>If the referenced images are in the reverse order, that range will be completely ignored. Unlike CloneImages().</p></ol>
270
271<p>The format of the DeleteImages method is:</p>
272
273<pre class="code">
274 DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
275</pre>
276
277<p>A description of each parameter follows:</p></ol>
278
279<h5>images</h5>
280<ol><p>the image sequence.</p></ol>
281
282<h5>scenes</h5>
283<ol><p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p></ol>
284
285<h5>exception</h5>
286<ol><p>return any errors or warnings in this structure.</p></ol>
287
288 </div>
289<h2><a href="http://www.imagemagick.org/api/MagickCore/list
290_8c.html" target="source" name="DestroyImageList">DestroyImageList</a></h2>
291<div class="doc-section">
292
293<p>DestroyImageList() destroys an image list.</p></ol>
294
295<p>The format of the DestroyImageList method is:</p>
296
297<pre class="code">
298 Image *DestroyImageList(Image *image)
299</pre>
300
301<p>A description of each parameter follows:</p></ol>
302
303<h5>image</h5>
304<ol><p>the image sequence.</p></ol>
305
306 </div>
307<h2><a href="http://www.imagemagick.org/api/MagickCore/list
308_8c.html" target="source" name="GetFirstImageInList">GetFirstImageInList</a></h2>
309<div class="doc-section">
310
311<p>GetFirstImageInList() returns a pointer to the first image in the list.</p></ol>
312
313<p>The format of the GetFirstImageInList method is:</p>
314
315<pre class="code">
316 Image *GetFirstImageInList(const Image *images)
317</pre>
318
319<p>A description of each parameter follows:</p></ol>
320
321<h5>images</h5>
322<ol><p>the image list.</p></ol>
323
324 </div>
325<h2><a href="http://www.imagemagick.org/api/MagickCore/list
326_8c.html" target="source" name="GetImageFromList">GetImageFromList</a></h2>
327<div class="doc-section">
328
329<p>GetImageFromList() returns an image at the specified offset from the list.</p></ol>
330
331<p>The format of the GetImageFromList method is:</p>
332
333<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]334 Image *GetImageFromList(const Image *images,const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335</pre>
336
337<p>A description of each parameter follows:</p></ol>
338
339<h5>images</h5>
340<ol><p>the image list.</p></ol>
341
342<h5>index</h5>
343<ol><p>the position within the list.</p></ol>
344
345 </div>
346<h2><a href="http://www.imagemagick.org/api/MagickCore/list
347_8c.html" target="source" name="GetImageIndexInList">GetImageIndexInList</a></h2>
348<div class="doc-section">
349
350<p>GetImageIndexInList() returns the offset in the list of the specified image.</p></ol>
351
352<p>The format of the GetImageIndexInList method is:</p>
353
354<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]355 ssize_t GetImageIndexInList(const Image *images)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]356</pre>
357
358<p>A description of each parameter follows:</p></ol>
359
360<h5>images</h5>
361<ol><p>the image list.</p></ol>
362
363 </div>
364<h2><a href="http://www.imagemagick.org/api/MagickCore/list
365_8c.html" target="source" name="GetImageListLength">GetImageListLength</a></h2>
366<div class="doc-section">
367
368<p>GetImageListLength() returns the length of the list (the number of images in the list).</p></ol>
369
370<p>The format of the GetImageListLength method is:</p>
371
372<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]373 size_t GetImageListLength(const Image *images)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]374</pre>
375
376<p>A description of each parameter follows:</p></ol>
377
378<h5>images</h5>
379<ol><p>the image list.</p></ol>
380
381 </div>
382<h2><a href="http://www.imagemagick.org/api/MagickCore/list
383_8c.html" target="source" name="GetLastImageInList">GetLastImageInList</a></h2>
384<div class="doc-section">
385
386<p>GetLastImageInList() returns a pointer to the last image in the list.</p></ol>
387
388<p>The format of the GetLastImageInList method is:</p>
389
390<pre class="code">
391 Image *GetLastImageInList(const Image *images)
392</pre>
393
394<p>A description of each parameter follows:</p></ol>
395
396<h5>images</h5>
397<ol><p>the image list.</p></ol>
398
399 </div>
400<h2><a href="http://www.imagemagick.org/api/MagickCore/list
401_8c.html" target="source" name="GetNextImageInList">GetNextImageInList</a></h2>
402<div class="doc-section">
403
404<p>GetNextImageInList() returns the next image in the list.</p></ol>
405
406<p>The format of the GetNextImageInList method is:</p>
407
408<pre class="code">
409 Image *GetNextImageInList(const Image *images)
410</pre>
411
412<p>A description of each parameter follows:</p></ol>
413
414<h5>images</h5>
415<ol><p>the image list.</p></ol>
416
417 </div>
418<h2><a href="http://www.imagemagick.org/api/MagickCore/list
419_8c.html" target="source" name="GetPreviousImageInList">GetPreviousImageInList</a></h2>
420<div class="doc-section">
421
422<p>GetPreviousImageInList() returns the previous image in the list.</p></ol>
423
424<p>The format of the GetPreviousImageInList method is:</p>
425
426<pre class="code">
427 Image *GetPreviousImageInList(const Image *images)
428</pre>
429
430<p>A description of each parameter follows:</p></ol>
431
432<h5>images</h5>
433<ol><p>the image list.</p></ol>
434
435 </div>
436<h2><a href="http://www.imagemagick.org/api/MagickCore/list
437_8c.html" target="source" name="ImageListToArray">ImageListToArray</a></h2>
438<div class="doc-section">
439
440<p>ImageListToArray() is a convenience method that converts an image list to a sequential array. For example,</p></ol>
441
442<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></ol>
443
444<p>The format of the ImageListToArray method is:</p>
445
446<pre class="code">
447 Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
448</pre>
449
450<p>A description of each parameter follows:</p></ol>
451
452<h5>image</h5>
453<ol><p>the image list.</p></ol>
454
455<h5>exception</h5>
456<ol><p>return any errors or warnings in this structure.</p></ol>
457
458 </div>
459<h2><a href="http://www.imagemagick.org/api/MagickCore/list
460_8c.html" target="source" name="InsertImageInList">InsertImageInList</a></h2>
461<div class="doc-section">
462
cristyd4d64ed2010-08-22 22:19:33 +0000[diff] [blame]463<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></ol>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]464
465<p>The format of the InsertImageInList method is:</p>
466
467<pre class="code">
468 InsertImageInList(Image **images,Image *image)
469</pre>
470
471<p>A description of each parameter follows:</p></ol>
472
473<h5>images</h5>
474<ol><p>the image list to insert into.</p></ol>
475
476<h5>image</h5>
477<ol><p>the image list to insert.</p></ol>
478
479 </div>
480<h2><a href="http://www.imagemagick.org/api/MagickCore/list
481_8c.html" target="source" name="NewImageList">NewImageList</a></h2>
482<div class="doc-section">
483
484<p>NewImageList() creates an empty image list.</p></ol>
485
486<p>The format of the NewImageList method is:</p>
487
488<pre class="code">
489 Image *NewImageList(void)
490</pre>
491
492 </div>
493<h2><a href="http://www.imagemagick.org/api/MagickCore/list
494_8c.html" target="source" name="PrependImageToList">PrependImageToList</a></h2>
495<div class="doc-section">
496
497<p>PrependImageToList() prepends the image to the beginning of the list.</p></ol>
498
499<p>The format of the PrependImageToList method is:</p>
500
501<pre class="code">
502 PrependImageToList(Image *images,Image *image)
503</pre>
504
505<p>A description of each parameter follows:</p></ol>
506
507<h5>images</h5>
508<ol><p>the image list.</p></ol>
509
510<h5>image</h5>
511<ol><p>the image.</p></ol>
512
513 </div>
514<h2><a href="http://www.imagemagick.org/api/MagickCore/list
515_8c.html" target="source" name="RemoveImageFromList">RemoveImageFromList</a></h2>
516<div class="doc-section">
517
518<p>RemoveImageFromList() removes and returns the image pointed to.</p></ol>
519
520<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></ol>
521
522<p>The format of the RemoveImageFromList method is:</p>
523
524<pre class="code">
525 Image *RemoveImageFromList(Image **images)
526</pre>
527
528<p>A description of each parameter follows:</p></ol>
529
530<h5>images</h5>
531<ol><p>the image list.</p></ol>
532
533 </div>
534<h2><a href="http://www.imagemagick.org/api/MagickCore/list
535_8c.html" target="source" name="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
536<div class="doc-section">
537
538<p>RemoveFirstImageFromList() removes and returns the first image in the list.</p></ol>
539
540<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></ol>
541
542<p>The format of the RemoveFirstImageFromList method is:</p>
543
544<pre class="code">
545 Image *RemoveFirstImageFromList(Image **images)
546</pre>
547
548<p>A description of each parameter follows:</p></ol>
549
550<h5>images</h5>
551<ol><p>the image list.</p></ol>
552
553 </div>
554<h2><a href="http://www.imagemagick.org/api/MagickCore/list
555_8c.html" target="source" name="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
556<div class="doc-section">
557
558<p>RemoveLastImageFromList() removes and returns the last image from the list.</p></ol>
559
560<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></ol>
561
562<p>The format of the RemoveLastImageFromList method is:</p>
563
564<pre class="code">
565 Image *RemoveLastImageFromList(Image **images)
566</pre>
567
568<p>A description of each parameter follows:</p></ol>
569
570<h5>images</h5>
571<ol><p>the image list.</p></ol>
572
573 </div>
574<h2><a href="http://www.imagemagick.org/api/MagickCore/list
575_8c.html" target="source" name="ReplaceImageInList">ReplaceImageInList</a></h2>
576<div class="doc-section">
577
578<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></ol>
579
580<p>The format of the ReplaceImageInList method is:</p>
581
582<pre class="code">
583 ReplaceImageInList(Image **images,Image *image)
584</pre>
585
586<p>A description of each parameter follows:</p></ol>
587
588<h5>images</h5>
589<ol><p>the image list.</p></ol>
590
591<h5>image</h5>
592<ol><p>the image.</p></ol>
593
594 </div>
595<h2><a href="http://www.imagemagick.org/api/MagickCore/list
596_8c.html" target="source" name="ReverseImageList">ReverseImageList</a></h2>
597<div class="doc-section">
598
599<p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p></ol>
600
601<p>The format of the ReverseImageList method is:</p>
602
603<pre class="code">
604 void ReverseImageList(Image **images)
605</pre>
606
607<p>A description of each parameter follows:</p></ol>
608
609<h5>images</h5>
610<ol><p>the image list.</p></ol>
611
612 </div>
613<h2><a href="http://www.imagemagick.org/api/MagickCore/list
614_8c.html" target="source" name="SpliceImageIntoList">SpliceImageIntoList</a></h2>
615<div class="doc-section">
616
617<p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p></ol>
618
619<p>The format of the SpliceImageIntoList method is:</p>
620
621<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]622 SpliceImageIntoList(Image **images,const size_t,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]623 const Image *splice)
624</pre>
625
626<p>A description of each parameter follows:</p></ol>
627
628<h5>images</h5>
629<ol><p>the image list.</p></ol>
630
631<h5>length</h5>
632<ol><p>the length of the image list to remove.</p></ol>
633
634<h5>splice</h5>
635<ol><p>Replace the removed image list with this list.</p></ol>
636
637 </div>
638<h2><a href="http://www.imagemagick.org/api/MagickCore/list
639_8c.html" target="source" name="SplitImageList">SplitImageList</a></h2>
640<div class="doc-section">
641
642<p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p></ol>
643
644<p>The format of the SplitImageList method is:</p>
645
646<pre class="code">
647 Image *SplitImageList(Image *images)
648</pre>
649
650<p>A description of each parameter follows:</p></ol>
651
652<h5>images</h5>
653<ol><p>the image list.</p></ol>
654
655 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]656
657</div>
658
659<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]660 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]661 <span id="linkbar-center">
662 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]663 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]664 </span>
665 <span id="linkbar-east">&nbsp;</span>
666 </div>
667 <div class="footer">
668 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
669 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
670 </div>
671 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]672 <script type="text/javascript">
673 var _gaq = _gaq || [];
674 _gaq.push(['_setAccount', 'UA-17690367-1']);
675 _gaq.push(['_trackPageview']);
676
677 (function() {
678 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
679 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
680 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
681 })();
682 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]683</body>
684</html>