]> granicus.if.org Git - imagemagick/blob - www/api/list.html
(no commit message)
[imagemagick] / www / api / list.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
8 <head>\r
9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
11   <title>ImageMagick: MagickCore, C API for ImageMagick: Working with Image Lists</title>
12   <meta http-equiv="Content-Language" content="en-US"/>
13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15   <meta name="Application-name" content="ImageMagick"/>
16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
17   <meta name="Application-url" content="http://www.imagemagick.org"/>
18   <meta name="Generator" content="PHP"/>
19   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, working, with, image, lists, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
20   <meta name="Rating" content="GENERAL"/>
21   <meta name="Robots" content="INDEX, FOLLOW"/>
22   <meta name="Generator" content="ImageMagick Studio LLC"/>
23   <meta name="Author" content="ImageMagick Studio LLC"/>
24   <meta name="Revisit-after" content="2 DAYS"/>
25   <meta name="Resource-type" content="document"/>
26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
27   <meta name="Distribution" content="Global"/>
28   <link rel="icon" href="../../images/wand.png"/>
29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
32   <style type="text/css" media="all">\r
33     @import url("../../www/magick.css");\r
34   </style>\r
35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
38   <script type="text/javascript">\r
39     $(document).ready(function() {\r
40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
41         'transitionIn'  : 'elastic',\r
42         'transitionOut' : 'elastic',\r
43         'overlayShow'   : false,\r
44         'opacity'       : true\r
45       });\r
46     });\r
47   </script>\r
48 </head>\r
49 \r
50 <body id="www-imagemagick-org">\r
51 <div class="titlebar">\r
52 <div style="margin: 17px auto; float: left;">\r
53   <script type="text/javascript">\r
54   <!--\r
55     google_ad_client = "pub-3129977114552745";\r
56     google_ad_slot = "5439289906";\r
57     google_ad_width = 728;\r
58     google_ad_height = 90;\r
59   //-->\r
60   </script>\r
61   <script type="text/javascript"\r
62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
63   </script>\r
64 </div>\r
65 <a href="http://www.imagemagick.org/discourse-server/">\r
66   <img src="../../images/logo.jpg"\r
67   alt="ImageMagick Logo"\r
68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
69 <a href="../../index.html">\r
70   <img src="../../images/sprite.jpg"\r
71   alt="ImageMagick Sprite"\r
72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
73 </div>\r
74 \r
75 <div class="westbar">\r
76 \r
77 <div class="menu">
78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
79 </div>
80 <div class="sep"></div>\r
81 <div class="menu">
82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
83 </div>
84 <div class="sub">
85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
86 </div>
87 <div class="sub">
88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
89 </div>
90 <div class="sub">
91     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
92 </div>
93 <div class="sub">
94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
95 </div>
96 <div class="sep"></div>\r
97 <div class="menu">
98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
99 </div>
100 <div class="sub">
101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
102 </div>
103 <div class="sub">
104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
105 </div>
106 <div class="sub">
107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
108 </div>
109 <div class="menu">
110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
111 </div>
112 <div class="sub">
113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
114 </div>
115 <div class="sub">
116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
117 </div>
118 <div class="sub">
119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
120 </div>
121 <div class="sub">
122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
123 </div>
124 <div class="sep"></div>\r
125 <div  class="menu">
126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
127 </div>
128 <div class="sub">
129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
130 </div>
131 <div class="sub">
132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
133  </div>
134 <div class="menu">
135   <a title="Resources" href="../../www/resources.html">Resources</a>
136 </div>
137 <div class="menu">
138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
139 </div>
140 <div class="menu">
141   <a title="Download" href="../../www/download.html">Download</a>
142 </div>
143 <div class="sep"></div>\r
144 <div class="menu">
145   <a title="Search" href="../../www/search.html">Search</a>
146 </div>
147 <div class="sep"></div>\r
148 <div class="menu">
149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
150 </div>
151 <div  class="sub">
152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
153 </div>
154 <div class="sep"></div>\r
155 <div  class="menu">
156   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
157
158 <a href="http://www.networkredux.com">
159   <img src="../../images/networkredux.png" alt="[sponsor]"
160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
161 <div class="sponsbox">
162 <div  class="sponsor">
163   <a title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
164 </div>
165 <div  class="sponsor">
166   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
167 </div>
168 <div  class="sponsor">
169   <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
170 </div>
171 <div  class="sponsor">
172   <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201107010090 alexanian media -->
173 </div>
174 <div  class="sponsor">
175   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
176 </div>
177 <div  class="sponsor">
178   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
179 </div>
180 <div  class="sponsor">
181   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
182 </div>
183 <div  class="sponsor">
184   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
185 </div>
186 <div  class="sponsor">
187    <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011080100025 atlas.multimedia-->
188 </div>
189 </div>
190 </div>
191 </div>\r
192 \r
193 <div class="eastbar">\r
194 \r
195 </div>\r
196 \r
197 <div class="main">\r
198 \r
199 <h1>Module list Methods</h1>
200 <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="#DuplicateImages">DuplicateImages</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="#ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a> &bull; <a href="#ReverseImageList">ReverseImageList</a> &bull; <a href="#SpliceImageIntoList">SpliceImageIntoList</a> &bull; <a href="#SplitImageList">SplitImageList</a>]</p>
201
202 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="AppendImageToList">AppendImageToList</a></h2>
203 <div class="doc-section">
204
205 <p>AppendImageToList() appends the second image list to the end of the first list.  The given image list pointer is left unchanged, unless it was empty.</p>
206
207 <p>The format of the AppendImageToList method is:</p>
208
209 <pre class="code">
210   AppendImageToList(Image *images,const Image *image)
211 </pre>
212
213 <p>A description of each parameter follows:</p>
214
215 <h5>images</h5>
216 <p>the image list to be appended to.</p>
217
218 <h5>image</h5>
219 <p>the appended image or image list.</p>
220
221  </div>
222 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImageList">CloneImageList</a></h2>
223 <div class="doc-section">
224
225 <p>CloneImageList() returns a duplicate of the image list.</p>
226
227 <p>The format of the CloneImageList method is:</p>
228
229 <pre class="code">
230   Image *CloneImageList(const Image *images,ExceptionInfo *exception)
231 </pre>
232
233 <p>A description of each parameter follows:</p>
234
235 <h5>images</h5>
236 <p>the image list.</p>
237
238 <h5>exception</h5>
239 <p>return any errors or warnings in this structure.</p>
240
241  </div>
242 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="CloneImages">CloneImages</a></h2>
243 <div class="doc-section">
244
245 <p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
246
247 <p>The numbers start at 0 for the first image in the list, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times to clone them multiple times. Images refered beyond the available number of images in list are ignored.</p>
248
249 <p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p>
250
251 <p>The format of the CloneImages method is:</p>
252
253 <pre class="code">
254   Image *CloneImages(const Image *images,const char *scenes,
255     ExceptionInfo *exception)
256 </pre>
257
258 <p>A description of each parameter follows:</p>
259
260 <h5>images</h5>
261 <p>the image sequence.</p>
262
263 <h5>scenes</h5>
264 <p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p>
265
266 <h5>exception</h5>
267 <p>return any errors or warnings in this structure.</p>
268
269  </div>
270 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImageFromList">DeleteImageFromList</a></h2>
271 <div class="doc-section">
272
273 <p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p>
274
275 <p>The format of the DeleteImageFromList method is:</p>
276
277 <pre class="code">
278   DeleteImageFromList(Image **images)
279 </pre>
280
281 <p>A description of each parameter follows:</p>
282
283 <h5>images</h5>
284 <p>the image list.</p>
285
286  </div>
287 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DeleteImages">DeleteImages</a></h2>
288 <div class="doc-section">
289
290 <p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
291
292 <p>The numbers start at 0 for the first image, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times without problems. Image refered beyond the available number of images in list are ignored.</p>
293
294 <p>If the referenced images are in the reverse order, that range will be completely ignored, unlike CloneImages().</p>
295
296 <p>The format of the DeleteImages method is:</p>
297
298 <pre class="code">
299   DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
300 </pre>
301
302 <p>A description of each parameter follows:</p>
303
304 <h5>images</h5>
305 <p>the image sequence.</p>
306
307 <h5>scenes</h5>
308 <p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p>
309
310 <h5>exception</h5>
311 <p>return any errors or warnings in this structure.</p>
312
313  </div>
314 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DestroyImageList">DestroyImageList</a></h2>
315 <div class="doc-section">
316
317 <p>DestroyImageList() destroys an image list.</p>
318
319 <p>The format of the DestroyImageList method is:</p>
320
321 <pre class="code">
322   Image *DestroyImageList(Image *image)
323 </pre>
324
325 <p>A description of each parameter follows:</p>
326
327 <h5>image</h5>
328 <p>the image sequence.</p>
329
330  </div>
331 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="DuplicateImages">DuplicateImages</a></h2>
332 <div class="doc-section">
333
334 <p>DuplicateImages() duplicates one or more images from an image sequence, using a count and a comma separated list of image numbers or ranges.</p>
335
336 <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>
337
338 <p>The format of the DuplicateImages method is:</p>
339
340 <pre class="code">
341   Image *DuplicateImages(Image *images,const size_t number_duplicates,
342     const char *scenes,ExceptionInfo *exception)
343 </pre>
344
345 <p>A description of each parameter follows:</p>
346
347 <h5>images</h5>
348 <p>the image sequence.</p>
349
350 <h5>number_duplicates</h5>
351 <p>duplicate the image sequence this number of times.</p>
352
353 <h5>scenes</h5>
354 <p>This character string specifies which scenes to duplicate (e.g. 1,3-5,-2-6,2).</p>
355
356 <h5>exception</h5>
357 <p>return any errors or warnings in this structure.</p>
358
359  </div>
360 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetFirstImageInList">GetFirstImageInList</a></h2>
361 <div class="doc-section">
362
363 <p>GetFirstImageInList() returns a pointer to the first image in the list.</p>
364
365 <p>The format of the GetFirstImageInList method is:</p>
366
367 <pre class="code">
368   Image *GetFirstImageInList(const Image *images)
369 </pre>
370
371 <p>A description of each parameter follows:</p>
372
373 <h5>images</h5>
374 <p>the image list.</p>
375
376  </div>
377 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageFromList">GetImageFromList</a></h2>
378 <div class="doc-section">
379
380 <p>GetImageFromList() returns an image at the specified offset from the list.</p>
381
382 <p>The format of the GetImageFromList method is:</p>
383
384 <pre class="code">
385   Image *GetImageFromList(const Image *images,const ssize_t index)
386 </pre>
387
388 <p>A description of each parameter follows:</p>
389
390 <h5>images</h5>
391 <p>the image list.</p>
392
393 <h5>index</h5>
394 <p>the position within the list.</p>
395
396  </div>
397 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageIndexInList">GetImageIndexInList</a></h2>
398 <div class="doc-section">
399
400 <p>GetImageIndexInList() returns the offset in the list of the specified image.</p>
401
402 <p>The format of the GetImageIndexInList method is:</p>
403
404 <pre class="code">
405   ssize_t GetImageIndexInList(const Image *images)
406 </pre>
407
408 <p>A description of each parameter follows:</p>
409
410 <h5>images</h5>
411 <p>the image list.</p>
412
413  </div>
414 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetImageListLength">GetImageListLength</a></h2>
415 <div class="doc-section">
416
417 <p>GetImageListLength() returns the length of the list (the number of images in the list).</p>
418
419 <p>The format of the GetImageListLength method is:</p>
420
421 <pre class="code">
422   size_t GetImageListLength(const Image *images)
423 </pre>
424
425 <p>A description of each parameter follows:</p>
426
427 <h5>images</h5>
428 <p>the image list.</p>
429
430  </div>
431 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetLastImageInList">GetLastImageInList</a></h2>
432 <div class="doc-section">
433
434 <p>GetLastImageInList() returns a pointer to the last image in the list.</p>
435
436 <p>The format of the GetLastImageInList method is:</p>
437
438 <pre class="code">
439   Image *GetLastImageInList(const Image *images)
440 </pre>
441
442 <p>A description of each parameter follows:</p>
443
444 <h5>images</h5>
445 <p>the image list.</p>
446
447  </div>
448 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetNextImageInList">GetNextImageInList</a></h2>
449 <div class="doc-section">
450
451 <p>GetNextImageInList() returns the next image in the list.</p>
452
453 <p>The format of the GetNextImageInList method is:</p>
454
455 <pre class="code">
456   Image *GetNextImageInList(const Image *images)
457 </pre>
458
459 <p>A description of each parameter follows:</p>
460
461 <h5>images</h5>
462 <p>the image list.</p>
463
464  </div>
465 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="GetPreviousImageInList">GetPreviousImageInList</a></h2>
466 <div class="doc-section">
467
468 <p>GetPreviousImageInList() returns the previous image in the list.</p>
469
470 <p>The format of the GetPreviousImageInList method is:</p>
471
472 <pre class="code">
473   Image *GetPreviousImageInList(const Image *images)
474 </pre>
475
476 <p>A description of each parameter follows:</p>
477
478 <h5>images</h5>
479 <p>the image list.</p>
480
481  </div>
482 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ImageListToArray">ImageListToArray</a></h2>
483 <div class="doc-section">
484
485 <p>ImageListToArray() is a convenience method that converts an image list to a sequential array.  For example,</p>
486
487 <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>
488
489 <p>The format of the ImageListToArray method is:</p>
490
491 <pre class="code">
492   Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
493 </pre>
494
495 <p>A description of each parameter follows:</p>
496
497 <h5>image</h5>
498 <p>the image list.</p>
499
500 <h5>exception</h5>
501 <p>return any errors or warnings in this structure.</p>
502
503  </div>
504 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="InsertImageInList">InsertImageInList</a></h2>
505 <div class="doc-section">
506
507 <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>
508
509 <p>The format of the InsertImageInList method is:</p>
510
511 <pre class="code">
512   InsertImageInList(Image **images,Image *image)
513 </pre>
514
515 <p>A description of each parameter follows:</p>
516
517 <h5>images</h5>
518 <p>the image list to insert into.</p>
519
520 <h5>image</h5>
521 <p>the image list to insert.</p>
522
523  </div>
524 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="NewImageList">NewImageList</a></h2>
525 <div class="doc-section">
526
527 <p>NewImageList() creates an empty image list.</p>
528
529 <p>The format of the NewImageList method is:</p>
530
531 <pre class="code">
532   Image *NewImageList(void)
533 </pre>
534
535  </div>
536 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="PrependImageToList">PrependImageToList</a></h2>
537 <div class="doc-section">
538
539 <p>PrependImageToList() prepends the image to the beginning of the list.</p>
540
541 <p>The format of the PrependImageToList method is:</p>
542
543 <pre class="code">
544   PrependImageToList(Image *images,Image *image)
545 </pre>
546
547 <p>A description of each parameter follows:</p>
548
549 <h5>images</h5>
550 <p>the image list.</p>
551
552 <h5>image</h5>
553 <p>the image.</p>
554
555  </div>
556 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveImageFromList">RemoveImageFromList</a></h2>
557 <div class="doc-section">
558
559 <p>RemoveImageFromList() removes and returns the image pointed to.</p>
560
561 <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>
562
563 <p>The format of the RemoveImageFromList method is:</p>
564
565 <pre class="code">
566   Image *RemoveImageFromList(Image **images)
567 </pre>
568
569 <p>A description of each parameter follows:</p>
570
571 <h5>images</h5>
572 <p>the image list.</p>
573
574  </div>
575 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
576 <div class="doc-section">
577
578 <p>RemoveFirstImageFromList() removes and returns the first image in the list.</p>
579
580 <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>
581
582 <p>The format of the RemoveFirstImageFromList method is:</p>
583
584 <pre class="code">
585   Image *RemoveFirstImageFromList(Image **images)
586 </pre>
587
588 <p>A description of each parameter follows:</p>
589
590 <h5>images</h5>
591 <p>the image list.</p>
592
593  </div>
594 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
595 <div class="doc-section">
596
597 <p>RemoveLastImageFromList() removes and returns the last image from the list.</p>
598
599 <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>
600
601 <p>The format of the RemoveLastImageFromList method is:</p>
602
603 <pre class="code">
604   Image *RemoveLastImageFromList(Image **images)
605 </pre>
606
607 <p>A description of each parameter follows:</p>
608
609 <h5>images</h5>
610 <p>the image list.</p>
611
612  </div>
613 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInList">ReplaceImageInList</a></h2>
614 <div class="doc-section">
615
616 <p>ReplaceImageInList() replaces an image in the list with the given image, or list of images.  Old image is destroyed.  The image list pointer is set to point to the first image of the inserted list of images.</p>
617
618 <p>The format of the ReplaceImageInList method is:</p>
619
620 <pre class="code">
621   ReplaceImageInList(Image **images,Image *image)
622 </pre>
623
624 <p>A description of each parameter follows:</p>
625
626 <h5>images</h5>
627 <p>the list and pointer to image to replace</p>
628
629 <h5>image</h5>
630 <p>the image or image list replacing the original</p>
631
632  </div>
633 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a></h2>
634 <div class="doc-section">
635
636 <p>ReplaceImageInListReturnLast() is exactly as ReplaceImageInList() except the image pointer is set to the last image in the list.</p>
637
638 <p>This allows you to simply use 'next' to go to the image that follows the just replaced image.</p>
639
640 <p>The format of the ReplaceImageInList method is:</p>
641
642 <pre class="code">
643   ReplaceImageInListReturnLast(Image **images,Image *image)
644 </pre>
645
646 <p>A description of each parameter follows:</p>
647
648 <h5>images</h5>
649 <p>the list and pointer to image to replace</p>
650
651 <h5>image</h5>
652 <p>the image or image list replacing the original</p>
653
654  </div>
655 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="ReverseImageList">ReverseImageList</a></h2>
656 <div class="doc-section">
657
658 <p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p>
659
660 <p>The format of the ReverseImageList method is:</p>
661
662 <pre class="code">
663   void ReverseImageList(Image **images)
664 </pre>
665
666 <p>A description of each parameter follows:</p>
667
668 <h5>images</h5>
669 <p>the image list.</p>
670
671  </div>
672 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SpliceImageIntoList">SpliceImageIntoList</a></h2>
673 <div class="doc-section">
674
675 <p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p>
676
677 <p>The format of the SpliceImageIntoList method is:</p>
678
679 <pre class="code">
680   SpliceImageIntoList(Image **images,const size_t,
681     const Image *splice)
682 </pre>
683
684 <p>A description of each parameter follows:</p>
685
686 <h5>images</h5>
687 <p>the image list.</p>
688
689 <h5>length</h5>
690 <p>the length of the image list to remove.</p>
691
692 <h5>splice</h5>
693 <p>Replace the removed image list with this list.</p>
694
695  </div>
696 <h2><a href="http://www.imagemagick.org/api/MagickCore/list_8c.html" id="SplitImageList">SplitImageList</a></h2>
697 <div class="doc-section">
698
699 <p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p>
700
701 <p>The format of the SplitImageList method is:</p>
702
703 <pre class="code">
704   Image *SplitImageList(Image *images)
705 </pre>
706
707 <p>A description of each parameter follows:</p>
708
709 <h5>images</h5>
710 <p>the image list.</p>
711
712  </div>
713 \r
714 </div>\r
715 \r
716 <div id="linkbar">\r
717     <span id="linkbar-west">&nbsp;</span>\r
718     <span id="linkbar-center">\r
719       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
720       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
721     </span>\r
722     <span id="linkbar-east">&nbsp;</span>\r
723   </div>\r
724   <div class="footer">\r
725     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
726     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
727   </div>\r
728   <div style="clear: both; margin: 0; width: 100%; "></div>\r
729   <script type="text/javascript">\r
730     var _gaq = _gaq || [];\r
731     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
732     _gaq.push(['_trackPageview']);\r
733 \r
734     (function() {\r
735       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
736       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
737       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
738     })();\r
739   </script>\r
740 </body>\r
741 </html>\r