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