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