blob: c442718f32b318d626a8e3a8ca754cf24c108079 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!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 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3de29cc2010-04-15 02:34:44 +00005 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00006 <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 +00008 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +00009 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000010 </style>
cristy3ed852e2009-09-05 21:47:34 +000011 <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 +000025 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000026 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</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 +000045<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000046
cristy3ed852e2009-09-05 21:47:34 +000047<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000048 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000049</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
cristybb503372010-05-27 20:51:26 +000052 <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 +000065 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
cristy3eaa0ef2010-03-06 20:35:26 +000091<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000092<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
cristybb503372010-05-27 20:51:26 +0000104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000124
125<div class="sponsbox">
126<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000127 <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 +0000130 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy8f900122010-03-05 15:26:31 +0000131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc1c61662009-09-30 14:04:37 +0000140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000143</div>
cristy3ed852e2009-09-05 21:47:34 +0000144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000147
cristyce69bb02010-07-27 19:49:46 +0000148<div class="eastbar">
149 <script type="text/javascript">
150 <!--
151 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000152 google_ad_slot = "0574824969";
153 google_ad_width = 160;
154 google_ad_height = 600;
155 //-->
156 </script>
157 <script type="text/javascript"
158 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
159 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000160</div>
161
162<div class="main">
163
cristy3ed852e2009-09-05 21:47:34 +0000164<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>
165
166<h2><a href="http://www.imagemagick.org/api/MagickCore/list
167_8c.html" target="source" name="AppendImageToList">AppendImageToList</a></h2>
168<div class="doc-section">
169
170<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>
171
172<p>The format of the AppendImageToList method is:</p>
173
174<pre class="code">
175 AppendImageToList(Image *images,const Image *image)
176</pre>
177
178<p>A description of each parameter follows:</p></ol>
179
180<h5>images</h5>
181<ol><p>the image list to be appended to.</p></ol>
182
183<h5>image</h5>
184<ol><p>the appended image or image list.</p></ol>
185
186 </div>
187<h2><a href="http://www.imagemagick.org/api/MagickCore/list
188_8c.html" target="source" name="CloneImageList">CloneImageList</a></h2>
189<div class="doc-section">
190
191<p>CloneImageList() returns a duplicate of the image list.</p></ol>
192
193<p>The format of the CloneImageList method is:</p>
194
195<pre class="code">
196 Image *CloneImageList(const Image *images,ExceptionInfo *exception)
197</pre>
198
199<p>A description of each parameter follows:</p></ol>
200
201<h5>images</h5>
202<ol><p>the image list.</p></ol>
203
204<h5>exception</h5>
205<ol><p>return any errors or warnings in this structure.</p></ol>
206
207 </div>
208<h2><a href="http://www.imagemagick.org/api/MagickCore/list
209_8c.html" target="source" name="CloneImages">CloneImages</a></h2>
210<div class="doc-section">
211
212<p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p></ol>
213
214<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>
215
216<p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p></ol>
217
218<p>The format of the CloneImages method is:</p>
219
220<pre class="code">
221 Image *CloneImages(const Image *images,const char *scenes,
222 ExceptionInfo *exception)
223</pre>
224
225<p>A description of each parameter follows:</p></ol>
226
227<h5>images</h5>
228<ol><p>the image sequence.</p></ol>
229
230<h5>scenes</h5>
231<ol><p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p></ol>
232
233<h5>exception</h5>
234<ol><p>return any errors or warnings in this structure.</p></ol>
235
236 </div>
237<h2><a href="http://www.imagemagick.org/api/MagickCore/list
238_8c.html" target="source" name="DeleteImageFromList">DeleteImageFromList</a></h2>
239<div class="doc-section">
240
241<p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p></ol>
242
243<p>The format of the DeleteImageFromList method is:</p>
244
245<pre class="code">
246 DeleteImageFromList(Image **images)
247</pre>
248
249<p>A description of each parameter follows:</p></ol>
250
251<h5>images</h5>
252<ol><p>the image list.</p></ol>
253
254 </div>
255<h2><a href="http://www.imagemagick.org/api/MagickCore/list
256_8c.html" target="source" name="DeleteImages">DeleteImages</a></h2>
257<div class="doc-section">
258
259<p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p></ol>
260
261<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>
262
263<p>If the referenced images are in the reverse order, that range will be completely ignored. Unlike CloneImages().</p></ol>
264
265<p>The format of the DeleteImages method is:</p>
266
267<pre class="code">
268 DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
269</pre>
270
271<p>A description of each parameter follows:</p></ol>
272
273<h5>images</h5>
274<ol><p>the image sequence.</p></ol>
275
276<h5>scenes</h5>
277<ol><p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p></ol>
278
279<h5>exception</h5>
280<ol><p>return any errors or warnings in this structure.</p></ol>
281
282 </div>
283<h2><a href="http://www.imagemagick.org/api/MagickCore/list
284_8c.html" target="source" name="DestroyImageList">DestroyImageList</a></h2>
285<div class="doc-section">
286
287<p>DestroyImageList() destroys an image list.</p></ol>
288
289<p>The format of the DestroyImageList method is:</p>
290
291<pre class="code">
292 Image *DestroyImageList(Image *image)
293</pre>
294
295<p>A description of each parameter follows:</p></ol>
296
297<h5>image</h5>
298<ol><p>the image sequence.</p></ol>
299
300 </div>
301<h2><a href="http://www.imagemagick.org/api/MagickCore/list
302_8c.html" target="source" name="GetFirstImageInList">GetFirstImageInList</a></h2>
303<div class="doc-section">
304
305<p>GetFirstImageInList() returns a pointer to the first image in the list.</p></ol>
306
307<p>The format of the GetFirstImageInList method is:</p>
308
309<pre class="code">
310 Image *GetFirstImageInList(const Image *images)
311</pre>
312
313<p>A description of each parameter follows:</p></ol>
314
315<h5>images</h5>
316<ol><p>the image list.</p></ol>
317
318 </div>
319<h2><a href="http://www.imagemagick.org/api/MagickCore/list
320_8c.html" target="source" name="GetImageFromList">GetImageFromList</a></h2>
321<div class="doc-section">
322
323<p>GetImageFromList() returns an image at the specified offset from the list.</p></ol>
324
325<p>The format of the GetImageFromList method is:</p>
326
327<pre class="code">
cristybb503372010-05-27 20:51:26 +0000328 Image *GetImageFromList(const Image *images,const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +0000329</pre>
330
331<p>A description of each parameter follows:</p></ol>
332
333<h5>images</h5>
334<ol><p>the image list.</p></ol>
335
336<h5>index</h5>
337<ol><p>the position within the list.</p></ol>
338
339 </div>
340<h2><a href="http://www.imagemagick.org/api/MagickCore/list
341_8c.html" target="source" name="GetImageIndexInList">GetImageIndexInList</a></h2>
342<div class="doc-section">
343
344<p>GetImageIndexInList() returns the offset in the list of the specified image.</p></ol>
345
346<p>The format of the GetImageIndexInList method is:</p>
347
348<pre class="code">
cristybb503372010-05-27 20:51:26 +0000349 ssize_t GetImageIndexInList(const Image *images)
cristy3ed852e2009-09-05 21:47:34 +0000350</pre>
351
352<p>A description of each parameter follows:</p></ol>
353
354<h5>images</h5>
355<ol><p>the image list.</p></ol>
356
357 </div>
358<h2><a href="http://www.imagemagick.org/api/MagickCore/list
359_8c.html" target="source" name="GetImageListLength">GetImageListLength</a></h2>
360<div class="doc-section">
361
362<p>GetImageListLength() returns the length of the list (the number of images in the list).</p></ol>
363
364<p>The format of the GetImageListLength method is:</p>
365
366<pre class="code">
cristybb503372010-05-27 20:51:26 +0000367 size_t GetImageListLength(const Image *images)
cristy3ed852e2009-09-05 21:47:34 +0000368</pre>
369
370<p>A description of each parameter follows:</p></ol>
371
372<h5>images</h5>
373<ol><p>the image list.</p></ol>
374
375 </div>
376<h2><a href="http://www.imagemagick.org/api/MagickCore/list
377_8c.html" target="source" name="GetLastImageInList">GetLastImageInList</a></h2>
378<div class="doc-section">
379
380<p>GetLastImageInList() returns a pointer to the last image in the list.</p></ol>
381
382<p>The format of the GetLastImageInList method is:</p>
383
384<pre class="code">
385 Image *GetLastImageInList(const Image *images)
386</pre>
387
388<p>A description of each parameter follows:</p></ol>
389
390<h5>images</h5>
391<ol><p>the image list.</p></ol>
392
393 </div>
394<h2><a href="http://www.imagemagick.org/api/MagickCore/list
395_8c.html" target="source" name="GetNextImageInList">GetNextImageInList</a></h2>
396<div class="doc-section">
397
398<p>GetNextImageInList() returns the next image in the list.</p></ol>
399
400<p>The format of the GetNextImageInList method is:</p>
401
402<pre class="code">
403 Image *GetNextImageInList(const Image *images)
404</pre>
405
406<p>A description of each parameter follows:</p></ol>
407
408<h5>images</h5>
409<ol><p>the image list.</p></ol>
410
411 </div>
412<h2><a href="http://www.imagemagick.org/api/MagickCore/list
413_8c.html" target="source" name="GetPreviousImageInList">GetPreviousImageInList</a></h2>
414<div class="doc-section">
415
416<p>GetPreviousImageInList() returns the previous image in the list.</p></ol>
417
418<p>The format of the GetPreviousImageInList method is:</p>
419
420<pre class="code">
421 Image *GetPreviousImageInList(const Image *images)
422</pre>
423
424<p>A description of each parameter follows:</p></ol>
425
426<h5>images</h5>
427<ol><p>the image list.</p></ol>
428
429 </div>
430<h2><a href="http://www.imagemagick.org/api/MagickCore/list
431_8c.html" target="source" name="ImageListToArray">ImageListToArray</a></h2>
432<div class="doc-section">
433
434<p>ImageListToArray() is a convenience method that converts an image list to a sequential array. For example,</p></ol>
435
436<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>
437
438<p>The format of the ImageListToArray method is:</p>
439
440<pre class="code">
441 Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
442</pre>
443
444<p>A description of each parameter follows:</p></ol>
445
446<h5>image</h5>
447<ol><p>the image list.</p></ol>
448
449<h5>exception</h5>
450<ol><p>return any errors or warnings in this structure.</p></ol>
451
452 </div>
453<h2><a href="http://www.imagemagick.org/api/MagickCore/list
454_8c.html" target="source" name="InsertImageInList">InsertImageInList</a></h2>
455<div class="doc-section">
456
457<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>
458
459<p>The format of the InsertImageInList method is:</p>
460
461<pre class="code">
462 InsertImageInList(Image **images,Image *image)
463</pre>
464
465<p>A description of each parameter follows:</p></ol>
466
467<h5>images</h5>
468<ol><p>the image list to insert into.</p></ol>
469
470<h5>image</h5>
471<ol><p>the image list to insert.</p></ol>
472
473 </div>
474<h2><a href="http://www.imagemagick.org/api/MagickCore/list
475_8c.html" target="source" name="NewImageList">NewImageList</a></h2>
476<div class="doc-section">
477
478<p>NewImageList() creates an empty image list.</p></ol>
479
480<p>The format of the NewImageList method is:</p>
481
482<pre class="code">
483 Image *NewImageList(void)
484</pre>
485
486 </div>
487<h2><a href="http://www.imagemagick.org/api/MagickCore/list
488_8c.html" target="source" name="PrependImageToList">PrependImageToList</a></h2>
489<div class="doc-section">
490
491<p>PrependImageToList() prepends the image to the beginning of the list.</p></ol>
492
493<p>The format of the PrependImageToList method is:</p>
494
495<pre class="code">
496 PrependImageToList(Image *images,Image *image)
497</pre>
498
499<p>A description of each parameter follows:</p></ol>
500
501<h5>images</h5>
502<ol><p>the image list.</p></ol>
503
504<h5>image</h5>
505<ol><p>the image.</p></ol>
506
507 </div>
508<h2><a href="http://www.imagemagick.org/api/MagickCore/list
509_8c.html" target="source" name="RemoveImageFromList">RemoveImageFromList</a></h2>
510<div class="doc-section">
511
512<p>RemoveImageFromList() removes and returns the image pointed to.</p></ol>
513
514<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>
515
516<p>The format of the RemoveImageFromList method is:</p>
517
518<pre class="code">
519 Image *RemoveImageFromList(Image **images)
520</pre>
521
522<p>A description of each parameter follows:</p></ol>
523
524<h5>images</h5>
525<ol><p>the image list.</p></ol>
526
527 </div>
528<h2><a href="http://www.imagemagick.org/api/MagickCore/list
529_8c.html" target="source" name="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
530<div class="doc-section">
531
532<p>RemoveFirstImageFromList() removes and returns the first image in the list.</p></ol>
533
534<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>
535
536<p>The format of the RemoveFirstImageFromList method is:</p>
537
538<pre class="code">
539 Image *RemoveFirstImageFromList(Image **images)
540</pre>
541
542<p>A description of each parameter follows:</p></ol>
543
544<h5>images</h5>
545<ol><p>the image list.</p></ol>
546
547 </div>
548<h2><a href="http://www.imagemagick.org/api/MagickCore/list
549_8c.html" target="source" name="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
550<div class="doc-section">
551
552<p>RemoveLastImageFromList() removes and returns the last image from the list.</p></ol>
553
554<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>
555
556<p>The format of the RemoveLastImageFromList method is:</p>
557
558<pre class="code">
559 Image *RemoveLastImageFromList(Image **images)
560</pre>
561
562<p>A description of each parameter follows:</p></ol>
563
564<h5>images</h5>
565<ol><p>the image list.</p></ol>
566
567 </div>
568<h2><a href="http://www.imagemagick.org/api/MagickCore/list
569_8c.html" target="source" name="ReplaceImageInList">ReplaceImageInList</a></h2>
570<div class="doc-section">
571
572<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>
573
574<p>The format of the ReplaceImageInList method is:</p>
575
576<pre class="code">
577 ReplaceImageInList(Image **images,Image *image)
578</pre>
579
580<p>A description of each parameter follows:</p></ol>
581
582<h5>images</h5>
583<ol><p>the image list.</p></ol>
584
585<h5>image</h5>
586<ol><p>the image.</p></ol>
587
588 </div>
589<h2><a href="http://www.imagemagick.org/api/MagickCore/list
590_8c.html" target="source" name="ReverseImageList">ReverseImageList</a></h2>
591<div class="doc-section">
592
593<p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p></ol>
594
595<p>The format of the ReverseImageList method is:</p>
596
597<pre class="code">
598 void ReverseImageList(Image **images)
599</pre>
600
601<p>A description of each parameter follows:</p></ol>
602
603<h5>images</h5>
604<ol><p>the image list.</p></ol>
605
606 </div>
607<h2><a href="http://www.imagemagick.org/api/MagickCore/list
608_8c.html" target="source" name="SpliceImageIntoList">SpliceImageIntoList</a></h2>
609<div class="doc-section">
610
611<p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p></ol>
612
613<p>The format of the SpliceImageIntoList method is:</p>
614
615<pre class="code">
cristybb503372010-05-27 20:51:26 +0000616 SpliceImageIntoList(Image **images,const size_t,
cristy3ed852e2009-09-05 21:47:34 +0000617 const Image *splice)
618</pre>
619
620<p>A description of each parameter follows:</p></ol>
621
622<h5>images</h5>
623<ol><p>the image list.</p></ol>
624
625<h5>length</h5>
626<ol><p>the length of the image list to remove.</p></ol>
627
628<h5>splice</h5>
629<ol><p>Replace the removed image list with this list.</p></ol>
630
631 </div>
632<h2><a href="http://www.imagemagick.org/api/MagickCore/list
633_8c.html" target="source" name="SplitImageList">SplitImageList</a></h2>
634<div class="doc-section">
635
636<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>
637
638<p>The format of the SplitImageList method is:</p>
639
640<pre class="code">
641 Image *SplitImageList(Image *images)
642</pre>
643
644<p>A description of each parameter follows:</p></ol>
645
646<h5>images</h5>
647<ol><p>the image list.</p></ol>
648
649 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000650
651</div>
652
653<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000654 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000655 <span id="linkbar-center">
656 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000657 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000658 </span>
659 <span id="linkbar-east">&nbsp;</span>
660 </div>
661 <div class="footer">
662 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
663 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
664 </div>
665 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000666 <script type="text/javascript">
667 var _gaq = _gaq || [];
668 _gaq.push(['_setAccount', 'UA-17690367-1']);
669 _gaq.push(['_trackPageview']);
670
671 (function() {
672 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
673 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
674 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
675 })();
676 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000677</body>
678</html>