File: list.html

package info (click to toggle)
imagemagick 6%3A6.0.6.2-2.9
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 33,284 kB
  • ctags: 14,844
  • sloc: ansic: 190,790; cpp: 17,203; sh: 8,740; perl: 4,190; makefile: 1,740; tcl: 459
file content (430 lines) | stat: -rw-r--r-- 18,381 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  "http://www.w3.org/TR/html4/loose.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>list - Working with Image Lists</title>
<link rel="stylesheet" type="text/css" href="../magick.css">
</head>

<body marginheight="1" marginwidth="1" topmargin="1" leftmargin="1">
<a name="top"></a> 
<table border="0" cellpadding="0" cellspacing="0" summary="Masthead" width="100%">
<tbody>
<tr>
<td bgcolor="#003399" width="25%" height="118" background="../../images/background.gif"><a href="http://www.imagemagick.org/"><img src="../../images/script.gif" width="278" height="118" border="0" alt="" /></a></td>
<td bgcolor="#003399" width="60%" height="118" background="../../images/background.gif"><a href="http://www.networkeleven.com/direct.php?magick_all"><img src="../../images/promote.png" border="0" width="186" height="52" vspace="29" alt="Powered by NetworkEleven" /></a></td>
<td bgcolor="#003399" width="114" height="118" align="right"><img src="../../images/sprite.png" width="114" height="118" alt="" /></td>
<td bgcolor="#003399" width="114" height="118" align="right"><a href="http://www.imagemagick.net"><img src="../../images/logo.png" width="114" height="118" border="0" alt="ImageMagick logo" /></a></td>
</tr></tbody></table>
<table align="left" border="0" cellpadding="2" cellspacing="2" summary="Navigation buttons" width="20%">
<tr>
<td>
<form target="_self" action="../../index.html"><input type="submit" title="ImageMagick Home" value=" Home" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/apis.html"><input type="submit" title="ImageMagick API" value=" API " style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/archives.html"><input type="submit" title="ImageMagick Download" value="Download" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td></tr></table>
<div align="right" style="margin-top:3px; padding-right:4px">
<form action="http://studio.imagemagick.org/Sage/scripts/Sage.cgi"><input type="TEXT" name="query" size="32" maxlength="255"> <input type="SUBMIT" name="sa" value="Search" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); bgcolor:#003399; color:#fbc713; font-weight:bold"></form></div>
<table align="left" border="0" cellpadding="10" cellspacing="0" style="margin-top:-17px" width="100%">
<tr>
<td>


<P><a name="__index__"></a></P>
<!-- INDEX BEGIN -->

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li>
	<ul>

		<li><a href="#appendimagetolist">AppendImageToList</a></li>
		<li><a href="#cloneimagelist">CloneImageList</a></li>
		<li><a href="#deleteimagefromlist">DeleteImageFromList</a></li>
		<li><a href="#destroyimagelist">DestroyImageList</a></li>
		<li><a href="#getfirstimageinlist">GetFirstImageInList</a></li>
		<li><a href="#getimagefromlist">GetImageFromList</a></li>
		<li><a href="#getimageindexinlist">GetImageIndexInList</a></li>
		<li><a href="#getimagelistlength">GetImageListLength</a></li>
		<li><a href="#getlastimageinlist">GetLastImageInList</a></li>
		<li><a href="#getnextimageinlist">GetNextImageInList</a></li>
		<li><a href="#getpreviousimageinlist">GetPreviousImageInList</a></li>
		<li><a href="#imagelisttoarray">ImageListToArray</a></li>
		<li><a href="#insertimageinlist">InsertImageInList</a></li>
		<li><a href="#newimagelist">NewImageList</a></li>
		<li><a href="#prependimagetolist">PrependImageToList</a></li>
		<li><a href="#removeimagefromlist">RemoveImageFromList</a></li>
		<li><a href="#removefirstimagefromlist">RemoveFirstImageFromList</a></li>
		<li><a href="#removelastimagefromlist">RemoveLastImageFromList</a></li>
		<li><a href="#replaceimageinlist">ReplaceImageInList</a></li>
		<li><a href="#reverseimagelist">ReverseImageList</a></li>
		<li><a href="#spliceimageintolist">SpliceImageIntoList</a></li>
		<li><a href="#splitimagelist">SplitImageList</a></li>
	</ul>

</ul>
<!-- INDEX END -->

<hr />
<P>
</P>
<h1><a name="name">NAME</a></h1>
<P>list - Working with Image Lists</P>
<P>
</P>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<P><strong>AppendImageToList</strong>( Image *images, const Image *image );</P>
<P>Image * <strong>CloneImageList</strong>( const Image *images, ExceptionInfo *exception );</P>
<P><strong>DeleteImageFromList</strong>( Image ** images );</P>
<P>void  <strong>DestroyImageList</strong>( Image *image );</P>
<P>Image * <strong>GetFirstImageInList</strong>( const Image *images );</P>
<P>Image * <strong>GetImageFromList</strong>( const Image *images, const long index );</P>
<P>long  <strong>GetImageIndexInList</strong>( const Image *images );</P>
<P>unsigned long  <strong>GetImageListLength</strong>( const Image *images );</P>
<P>Image * <strong>GetLastImageInList</strong>( const Image *images );</P>
<P>Image * <strong>GetNextImageInList</strong>( const Image *images );</P>
<P>Image * <strong>GetPreviousImageInList</strong>( const Image *images );</P>
<P>Image **  <strong>ImageListToArray</strong>( const Image *images, ExceptionInfo *exception );</P>
<P><strong>InsertImageInList</strong>( Image ** images, Image *image );</P>
<P>Image * <strong>NewImageList</strong>( void );</P>
<P><strong>PrependImageToList</strong>( Image *images, Image *image );</P>
<P>Image * <strong>RemoveFirstImageFromList</strong>( Image ** images );</P>
<P>Image * <strong>RemoveImageFromList</strong>( Image ** images );</P>
<P>Image * <strong>RemoveLastImageFromList</strong>( Image ** images );</P>
<P><strong>ReplaceImageInList</strong>( Image ** images, Image *image );</P>
<P><strong>ReverseImageList</strong>( const Image ** images );</P>
<P><strong>SpliceImageIntoList</strong>( Image ** images, const unsigned unsigned long, const Image *splice );</P>
<P>Image * <strong>SplitImageList</strong>( Image *images );</P>
<P>
</P>
<hr />
<h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1>
<P>
</P>
<h2><a name="appendimagetolist">AppendImageToList</a></h2>
<blockquote>AppendImageToList() appends an image to the end of the list. </blockquote><P>The format of the AppendImageToList method is:</P>
<blockquote>AppendImageToList ( <A HREF="types.html#Image">Image</A> *images, const <A HREF="types.html#Image">Image</A> *image ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_images_3a">images:</a></strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P>
<dt><strong><a name="item_o_image_3a">image:</a></strong><br />
</dt>
<DD>
The image.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="cloneimagelist">CloneImageList</a></h2>
<blockquote>CloneImageList() returns a duplicate of the image list. </blockquote><P>The format of the CloneImageList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *CloneImageList ( const <A HREF="types.html#Image">Image</A> *images, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P>
<dt><strong><a name="item_o_exception_3a">exception:</a></strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="deleteimagefromlist">DeleteImageFromList</a></h2>
<blockquote>DeleteImageFromList() deletes an image from the list. </blockquote><P>The format of the DeleteImageFromList method is:</P>
<blockquote>DeleteImageFromList ( <A HREF="types.html#Image">Image</A> **images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="destroyimagelist">DestroyImageList</a></h2>
<blockquote>DestroyImageList() destroys an image list. </blockquote><P>The format of the DestroyImageList method is:</P>
<blockquote>void DestroyImageList ( <A HREF="types.html#Image">Image</A> *image ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image sequence.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getfirstimageinlist">GetFirstImageInList</a></h2>
<blockquote>GetFirstImageInList() returns a pointer to the first image in the list. </blockquote><P>The format of the GetFirstImageInList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *GetFirstImageInList ( const <A HREF="types.html#Image">Image</A> *images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getimagefromlist">GetImageFromList</a></h2>
<blockquote>GetImageFromList() returns an image at the specified offset from the list. </blockquote><P>The format of the GetImageFromList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *GetImageFromList ( const <A HREF="types.html#Image">Image</A> *images, const long index ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P>
<dt><strong><a name="item_o_index_3a">index:</a></strong><br />
</dt>
<DD>
The position within the list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getimageindexinlist">GetImageIndexInList</a></h2>
<blockquote>GetImageIndexInList() returns the offset in the list of the specified image. </blockquote><P>The format of the GetImageIndexInList method is:</P>
<blockquote>long GetImageIndexInList ( const <A HREF="types.html#Image">Image</A> *images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getimagelistlength">GetImageListLength</a></h2>
<blockquote>GetImageListLength() returns the length of the list ( the number of images in the list ) . </blockquote><P>The format of the GetImageListLength method is:</P>
<blockquote>unsigned long GetImageListLength ( const <A HREF="types.html#Image">Image</A> *images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getlastimageinlist">GetLastImageInList</a></h2>
<blockquote>GetLastImageInList() returns a pointer to the last image in the list. </blockquote><P>The format of the GetLastImageInList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *GetLastImageInList ( const <A HREF="types.html#Image">Image</A> *images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getnextimageinlist">GetNextImageInList</a></h2>
<blockquote>GetNextImageInList() returns the next image in the list. </blockquote><P>The format of the GetNextImageInList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *GetNextImageInList ( const <A HREF="types.html#Image">Image</A> *images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getpreviousimageinlist">GetPreviousImageInList</a></h2>
<blockquote>GetPreviousImageInList() returns the previous image in the list. </blockquote><P>The format of the GetPreviousImageInList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *GetPreviousImageInList ( const <A HREF="types.html#Image">Image</A> *images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="imagelisttoarray">ImageListToArray</a></h2>
<blockquote>ImageListToArray() is a convenience method that converts an image list to a sequential array. For example, </blockquote><blockquote>group = ImageListToArray ( images, exception ); for ( i = 0; i < n; i++ ) puts ( group[i]->filename ) ;; </blockquote><P>The format of the ImageListToArray method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> **ImageListToArray ( const <A HREF="types.html#Image">Image</A> *images, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P>
<dt><strong>exception:</strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="insertimageinlist">InsertImageInList</a></h2>
<blockquote>InsertImageInList() inserts an image in the list. </blockquote><P>The format of the InsertImageInList method is:</P>
<blockquote>InsertImageInList ( <A HREF="types.html#Image">Image</A> **images, <A HREF="types.html#Image">Image</A> *image ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="newimagelist">NewImageList</a></h2>
<blockquote>NewImageList() creates an empty image list. </blockquote><P>The format of the NewImageList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *NewImageList ( void ); </blockquote><P>
</P>
<h2><a name="prependimagetolist">PrependImageToList</a></h2>
<blockquote>PrependImageToList() prepends the image to the beginning of the list. </blockquote><P>The format of the PrependImageToList method is:</P>
<blockquote>PrependImageToList ( <A HREF="types.html#Image">Image</A> *images, <A HREF="types.html#Image">Image</A> *image ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="removeimagefromlist">RemoveImageFromList</a></h2>
<blockquote>RemoveImageFromList() removes an image from the list. </blockquote><P>The format of the RemoveImageFromList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *RemoveImageFromList ( <A HREF="types.html#Image">Image</A> **images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="removefirstimagefromlist">RemoveFirstImageFromList</a></h2>
<blockquote>RemoveFirstImageFromList() removes the first image in the list. </blockquote><P>The format of the RemoveFirstImageFromList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *RemoveFirstImageFromList ( <A HREF="types.html#Image">Image</A> **images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="removelastimagefromlist">RemoveLastImageFromList</a></h2>
<blockquote>RemoveLastImageFromList() removes the last image from the list. </blockquote><P>The format of the RemoveLastImageFromList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *RemoveLastImageFromList ( <A HREF="types.html#Image">Image</A> **images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="replaceimageinlist">ReplaceImageInList</a></h2>
<blockquote>ReplaceImageInList() replaces an image in the list. </blockquote><P>The format of the ReplaceImageInList method is:</P>
<blockquote>ReplaceImageInList ( <A HREF="types.html#Image">Image</A> **images, <A HREF="types.html#Image">Image</A> *image ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P>
<dt><strong>image:</strong><br />
</dt>
<DD>
The image.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="reverseimagelist">ReverseImageList</a></h2>
<blockquote>ReverseImageList() reverses the image list. </blockquote><P>The format of the ReverseImageList method is:</P>
<blockquote>ReverseImageList ( const <A HREF="types.html#Image">Image</A> **images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="spliceimageintolist">SpliceImageIntoList</a></h2>
<blockquote>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. </blockquote><P>The format of the SpliceImageIntoList method is:</P>
<blockquote>SpliceImageIntoList ( <A HREF="types.html#Image">Image</A> **images, const unsigned unsigned long, const <A HREF="types.html#Image">Image</A> *splice ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
<P></P>
<dt><strong><a name="item_o_length_3a">length:</a></strong><br />
</dt>
<DD>
The length of the image list to remove.
</dd>
<P></P>
<dt><strong><a name="item_o_splice_3a">splice:</a></strong><br />
</dt>
<DD>
Replace the removed image list with this list.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="splitimagelist">SplitImageList</a></h2>
<blockquote>SplitImageList() splits an image into two lists. </blockquote><P>The format of the SplitImageList method is:</P>
<blockquote><A HREF="types.html#Image">Image</A> *SplitImageList ( <A HREF="types.html#Image">Image</A> *images ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>images:</strong><br />
</dt>
<DD>
The image list.
</dd>
</dl>


<HR>

<a href="#top"><img src="../../../images/top.gif" border=0 width=42 height=42 align="right" alt="Top of page"></a>
<form action="http://studio.imagemagick.org/magick/" style="margin-top:5px">
<input type="submit" title="Help!" value="Help!" style="background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold">
  <small>&quot;Image manipulation software that works like magick&quot;</small>
</form></td>
</tr></table>

</body>


</html>