| Current Path : /usr/local/share/doc/ImageMagick/www/api/ |
FreeBSD hs32.drive.ne.jp 9.1-RELEASE FreeBSD 9.1-RELEASE #1: Wed Jan 14 12:18:08 JST 2015 root@hs32.drive.ne.jp:/sys/amd64/compile/hs32 amd64 |
| Current File : //usr/local/share/doc/ImageMagick/www/api/list.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<style type="text/css" media="screen,projection"><!--
@import url("../../www/magick.css");
--></style>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<title>ImageMagick: MagickCore, C API for ImageMagick: Working with Image Lists</title>
<meta http-equiv="Content-Language" content="en-US"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
<meta name="Generator" content="PHP"/>
<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"/>
<meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
<meta name="Rating" content="GENERAL"/>
<meta name="Robots" content="INDEX, FOLLOW"/>
<meta name="Generator" content="ImageMagick Studio LLC"/>
<meta name="Author" content="ImageMagick Studio LLC"/>
<meta name="Revisit-after" content="2 DAYS"/>
<meta name="Resource-type" content="document"/>
<meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<a href="../../index.html">
<img src="../../images/script.png" alt="[ImageMagick]"
style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
<a href="http://www.networkredux.com">
<img src="../../images/networkredux.png" alt="[sponsor]"
style="margin: 45px auto; border: 0px; float: left;" /></a>
<a href="http://www.imagemagick.org/discourse-server/">
<img src="../../images/logo.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../index.html">
<img src="../../images/sprite.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="eastbar">
<div class="menu">
<a href="../../index.html">About ImageMagick</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a href="../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a href="../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a href="../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a href="../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a href="../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a href="../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a href="../../Magick++/">Magick++</a>
</div>
<div class="menu">
<a href="../../www/architecture.html">Architecture</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a href="../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a href="../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a href="../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="menu">
<a href="../../www/resources.html">Resources</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../http://www.imagemagick.org/script/search.php">Search</a>
</div><div class="sep"></div>
<div class="menu">
<a href="../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a href="../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/sponsors.html">Sponsors:</a>
<div class="sponsbox">
<div class="sponsor">
<a href="http://www.17things.com/">Answers to Questions</a><!-- 200904010200 -->
</div>
<div class="sponsor">
<a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
</div>
<div class="sponsor">
<a href="http://www.online-kredit-index.de">Kredit</a><!-- 200905010120 -->
</div>
<div class="sponsor">
<a href="http://www.posters555.com">Poster</a><!-- 200903010800 -->
</div>
</div>
</div>
</div>
<div class="main">
<p class="navigation-index">[ <a href="#AppendImageToList">AppendImageToList</a> | <a href="#CloneImageList">CloneImageList</a> | <a href="#CloneImages">CloneImages</a> | <a href="#DeleteImageFromList">DeleteImageFromList</a> | <a href="#DeleteImages">DeleteImages</a> | <a href="#DestroyImageList">DestroyImageList</a> | <a href="#GetFirstImageInList">GetFirstImageInList</a> | <a href="#GetImageFromList">GetImageFromList</a> | <a href="#GetImageIndexInList">GetImageIndexInList</a> | <a href="#GetImageListLength">GetImageListLength</a> | <a href="#GetLastImageInList">GetLastImageInList</a> | <a href="#GetNextImageInList">GetNextImageInList</a> | <a href="#GetPreviousImageInList">GetPreviousImageInList</a> | <a href="#ImageListToArray">ImageListToArray</a> | <a href="#InsertImageInList">InsertImageInList</a> | <a href="#NewImageList">NewImageList</a> | <a href="#PrependImageToList">PrependImageToList</a> | <a href="#RemoveImageFromList">RemoveImageFromList</a> | <a href="#RemoveFirstImageFromList">RemoveFirstImageFromList</a> | <a href="#RemoveLastImageFromList">RemoveLastImageFromList</a> | <a href="#ReplaceImageInList">ReplaceImageInList</a> | <a href="#ReverseImageList">ReverseImageList</a> | <a href="#SpliceImageIntoList">SpliceImageIntoList</a> | <a href="#SplitImageList">SplitImageList</a> ]</p>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="AppendImageToList">AppendImageToList</a></h2>
</div>
<p>AppendImageToList() appends the second image list to the end of the first list. The given image list pointer is left unchanged, unless it was empty.</p></ol>
<p>The format of the AppendImageToList method is:</p>
<pre class="code">
AppendImageToList(Image *images,const Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list to be appended to.</p></ol>
<h5>image</h5>
<ol><p>the appended image or image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="CloneImageList">CloneImageList</a></h2>
</div>
<p>CloneImageList() returns a duplicate of the image list.</p></ol>
<p>The format of the CloneImageList method is:</p>
<pre class="code">
Image *CloneImageList(const Image *images,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="CloneImages">CloneImages</a></h2>
</div>
<p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p></ol>
<p>The numbers start at 0 for the first image in the list, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times to clone them multiple times. Images refered beyond the available number of images in list are ignored.</p></ol>
<p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p></ol>
<p>The format of the CloneImages method is:</p>
<pre class="code">
Image *CloneImages(const Image *images,const char *scenes,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image sequence.</p></ol>
<h5>scenes</h5>
<ol><p>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2).</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="DeleteImageFromList">DeleteImageFromList</a></h2>
</div>
<p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p></ol>
<p>The format of the DeleteImageFromList method is:</p>
<pre class="code">
DeleteImageFromList(Image **images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="DeleteImages">DeleteImages</a></h2>
</div>
<p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p></ol>
<p>The numbers start at 0 for the first image, while negative numbers refer to images starting counting from the end of the range. Images may be refered to multiple times without problems. Image refered beyond the available number of images in list are ignored.</p></ol>
<p>If the referenced images are in the reverse order, that range will be completely ignored. Unlike CloneImages().</p></ol>
<p>The format of the DeleteImages method is:</p>
<pre class="code">
DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image sequence.</p></ol>
<h5>scenes</h5>
<ol><p>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2).</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="DestroyImageList">DestroyImageList</a></h2>
</div>
<p>DestroyImageList() destroys an image list.</p></ol>
<p>The format of the DestroyImageList method is:</p>
<pre class="code">
Image *DestroyImageList(Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image sequence.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="GetFirstImageInList">GetFirstImageInList</a></h2>
</div>
<p>GetFirstImageInList() returns a pointer to the first image in the list.</p></ol>
<p>The format of the GetFirstImageInList method is:</p>
<pre class="code">
Image *GetFirstImageInList(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="GetImageFromList">GetImageFromList</a></h2>
</div>
<p>GetImageFromList() returns an image at the specified offset from the list.</p></ol>
<p>The format of the GetImageFromList method is:</p>
<pre class="code">
Image *GetImageFromList(const Image *images,const long index)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>index</h5>
<ol><p>the position within the list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="GetImageIndexInList">GetImageIndexInList</a></h2>
</div>
<p>GetImageIndexInList() returns the offset in the list of the specified image.</p></ol>
<p>The format of the GetImageIndexInList method is:</p>
<pre class="code">
long GetImageIndexInList(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="GetImageListLength">GetImageListLength</a></h2>
</div>
<p>GetImageListLength() returns the length of the list (the number of images in the list).</p></ol>
<p>The format of the GetImageListLength method is:</p>
<pre class="code">
unsigned long GetImageListLength(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="GetLastImageInList">GetLastImageInList</a></h2>
</div>
<p>GetLastImageInList() returns a pointer to the last image in the list.</p></ol>
<p>The format of the GetLastImageInList method is:</p>
<pre class="code">
Image *GetLastImageInList(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="GetNextImageInList">GetNextImageInList</a></h2>
</div>
<p>GetNextImageInList() returns the next image in the list.</p></ol>
<p>The format of the GetNextImageInList method is:</p>
<pre class="code">
Image *GetNextImageInList(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="GetPreviousImageInList">GetPreviousImageInList</a></h2>
</div>
<p>GetPreviousImageInList() returns the previous image in the list.</p></ol>
<p>The format of the GetPreviousImageInList method is:</p>
<pre class="code">
Image *GetPreviousImageInList(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="ImageListToArray">ImageListToArray</a></h2>
</div>
<p>ImageListToArray() is a convenience method that converts an image list to a sequential array. For example,</p></ol>
<p>group = ImageListToArray(images, exception); while (i = 0; group[i] != (Image *) NULL; i++) printf("s\n", group[i]->filename); printf("d images\n", i); group = RelinquishMagickMemory(group);</p></ol>
<p>The format of the ImageListToArray method is:</p>
<pre class="code">
Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image list.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="InsertImageInList">InsertImageInList</a></h2>
</div>
<p>InsertImageInList() inserts the second image or image list into the first image list immediatally after the image pointed to. The given image list pointer is unchanged unless previously empty.</p></ol>
<p>The format of the InsertImageInList method is:</p>
<pre class="code">
InsertImageInList(Image **images,Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list to insert into.</p></ol>
<h5>image</h5>
<ol><p>the image list to insert.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="NewImageList">NewImageList</a></h2>
</div>
<p>NewImageList() creates an empty image list.</p></ol>
<p>The format of the NewImageList method is:</p>
<pre class="code">
Image *NewImageList(void)
</pre>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="PrependImageToList">PrependImageToList</a></h2>
</div>
<p>PrependImageToList() prepends the image to the beginning of the list.</p></ol>
<p>The format of the PrependImageToList method is:</p>
<pre class="code">
PrependImageToList(Image *images,Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="RemoveImageFromList">RemoveImageFromList</a></h2>
</div>
<p>RemoveImageFromList() removes and returns the image pointed to.</p></ol>
<p>The given image list pointer is set to point to the next image in list if it exists, otherwise it is set to the previous image, or NULL if list was emptied.</p></ol>
<p>The format of the RemoveImageFromList method is:</p>
<pre class="code">
Image *RemoveImageFromList(Image **images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
</div>
<p>RemoveFirstImageFromList() removes and returns the first image in the list.</p></ol>
<p>If the given image list pointer pointed to the removed first image, it is set to the new first image of list, or NULL if list was emptied, otherwise it is left as is.</p></ol>
<p>The format of the RemoveFirstImageFromList method is:</p>
<pre class="code">
Image *RemoveFirstImageFromList(Image **images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
</div>
<p>RemoveLastImageFromList() removes and returns the last image from the list.</p></ol>
<p>If the given image list pointer pointed to the removed last image, it is set to the new last image of list, or NULL if list was emptied, otherwise it is left as is.</p></ol>
<p>The format of the RemoveLastImageFromList method is:</p>
<pre class="code">
Image *RemoveLastImageFromList(Image **images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="ReplaceImageInList">ReplaceImageInList</a></h2>
</div>
<p>ReplaceImageInList() replaces an image in the list. Old image is destroyed. The given image list pointer is set to point to the just inserted image.</p></ol>
<p>The format of the ReplaceImageInList method is:</p>
<pre class="code">
ReplaceImageInList(Image **images,Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="ReverseImageList">ReverseImageList</a></h2>
</div>
<p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p></ol>
<p>The format of the ReverseImageList method is:</p>
<pre class="code">
void ReverseImageList(Image **images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="SpliceImageIntoList">SpliceImageIntoList</a></h2>
</div>
<p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p></ol>
<p>The format of the SpliceImageIntoList method is:</p>
<pre class="code">
SpliceImageIntoList(Image **images,const unsigned long,
const Image *splice)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>length</h5>
<ol><p>the length of the image list to remove.</p></ol>
<h5>splice</h5>
<ol><p>Replace the removed image list with this list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/list
_8c.html" target="source" name="SplitImageList">SplitImageList</a></h2>
</div>
<p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p></ol>
<p>The format of the SplitImageList method is:</p>
<pre class="code">
Image *SplitImageList(Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
</div>
<div id="linkbar">
<!-- <span id="linkbar-west"> </span> -->
<span id="linkbar-center">
<a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
<a href="../../www/mailing-list.html">Mailing Lists</a> •
<a href="http://cafe.imagemagick.org">Cafe</a> •
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east"> </span>
</div>
<div class="footer">
<span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>