File: //var/chroot/usr/share/doc/ImageMagick-7/www/api/list.html
<!doctype html>
<html lang="en" data-bs-theme="auto">
<head>
<script src="../../assets/color-modes.js" ></script>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ImageMagick – MagickCore, C API: Working with Image Lists</title>
<meta name="keywords" content="magickcore, c, api:, working, with, image, lists, ImageMagick, image processing, command-line tool, format conversion, photo editing" />
<meta name="description" content="" />
<meta name="application-name" content="ImageMagick" />
<meta name="application-url" content="https://imagemagick.org" />
<meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
<meta itemprop='url' content='../../' />
<meta itemprop='title' content='ImageMagick' />
<meta itemprop='description' content="ImageMagick is a free and open-source software suite used for editing and manipulating digital images. It provides a versatile set of tools for various image-related tasks. You can use ImageMagick to resize, convert, and apply various transformations to images. It supports a wide range of file formats, including JPEG, PNG, GIF, TIFF, and Ultra HDR." />
<meta property='og:url' content='../../' />
<meta property='og:name' content='ImageMagick' />
<meta property='og:image' content='../../../images/logo.png' />
<meta property='og:type' content='website' />
<meta property='og:site_name' content='ImageMagick' />
<meta property='og:description' content="ImageMagick is a free and open-source software suite used for editing and manipulating digital images. It provides a versatile set of tools for various image-related tasks. You can use ImageMagick to resize, convert, and apply various transformations to images. It supports a wide range of file formats, including JPEG, PNG, GIF, TIFF, and Ultra HDR." />
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
<link type="images/png" sizes="64x64" href="../../../images/wand.png" rel="icon" />
<link type="images/icon" sizes="16x16" href="../../../images/wand.ico" rel="shortcut icon" />
<link href="list.html" rel="canonical" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
<link href="../../assets/magick.css" rel="stylesheet" />
<script async src="https://localhost/pagead/js/adsbygoogle.js?client=ca-pub-3129977114552745" crossorigin="anonymous"></script>
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
<symbol id="check2" viewBox="0 0 16 16">
<path d="M13.854 3.646a.5.5 0 0 1 0 .708l-7 7a.5.5 0 0 1-.708 0l-3.5-3.5a.5.5 0 1 1 .708-.708L6.5 10.293l6.646-6.647a.5.5 0 0 1 .708 0z"/>
</symbol>
<symbol id="circle-half" viewBox="0 0 16 16">
<path d="M8 15A7 7 0 1 0 8 1v14zm0 1A8 8 0 1 1 8 0a8 8 0 0 1 0 16z"/>
</symbol>
<symbol id="moon-stars-fill" viewBox="0 0 16 16">
<path d="M6 .278a.768.768 0 0 1 .08.858 7.208 7.208 0 0 0-.878 3.46c0 4.021 3.278 7.277 7.318 7.277.527 0 1.04-.055 1.533-.16a.787.787 0 0 1 .81.316.733.733 0 0 1-.031.893A8.349 8.349 0 0 1 8.344 16C3.734 16 0 12.286 0 7.71 0 4.266 2.114 1.312 5.124.06A.752.752 0 0 1 6 .278z"/>
<path d="M10.794 3.148a.217.217 0 0 1 .412 0l.387 1.162c.173.518.579.924 1.097 1.097l1.162.387a.217.217 0 0 1 0 .412l-1.162.387a1.734 1.734 0 0 0-1.097 1.097l-.387 1.162a.217.217 0 0 1-.412 0l-.387-1.162A1.734 1.734 0 0 0 9.31 6.593l-1.162-.387a.217.217 0 0 1 0-.412l1.162-.387a1.734 1.734 0 0 0 1.097-1.097l.387-1.162zM13.863.099a.145.145 0 0 1 .274 0l.258.774c.115.346.386.617.732.732l.774.258a.145.145 0 0 1 0 .274l-.774.258a1.156 1.156 0 0 0-.732.732l-.258.774a.145.145 0 0 1-.274 0l-.258-.774a1.156 1.156 0 0 0-.732-.732l-.774-.258a.145.145 0 0 1 0-.274l.774-.258c.346-.115.617-.386.732-.732L13.863.1z"/>
</symbol>
<symbol id="sun-fill" viewBox="0 0 16 16">
<path d="M8 12a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM8 0a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 0zm0 13a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 13zm8-5a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2a.5.5 0 0 1 .5.5zM3 8a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2A.5.5 0 0 1 3 8zm10.657-5.657a.5.5 0 0 1 0 .707l-1.414 1.415a.5.5 0 1 1-.707-.708l1.414-1.414a.5.5 0 0 1 .707 0zm-9.193 9.193a.5.5 0 0 1 0 .707L3.05 13.657a.5.5 0 0 1-.707-.707l1.414-1.414a.5.5 0 0 1 .707 0zm9.193 2.121a.5.5 0 0 1-.707 0l-1.414-1.414a.5.5 0 0 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .707zM4.464 4.465a.5.5 0 0 1-.707 0L2.343 3.05a.5.5 0 1 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .708z"/>
</symbol>
</svg>
<div class="dropdown position-fixed bottom-0 end-0 mb-3 me-3 bd-mode-toggle">
<button class="btn btn-bd-secondary py-2 dropdown-toggle d-flex align-items-center"
id="bd-theme"
type="button"
aria-expanded="false"
data-bs-toggle="dropdown"
aria-label="Toggle theme (auto)">
<svg class="bi my-1 theme-icon-active" width="1em" height="1em"><use href="#circle-half"></use></svg>
<span class="visually-hidden" id="bd-theme-text">Toggle theme</span>
</button>
<ul class="dropdown-menu dropdown-menu-end shadow" aria-labelledby="bd-theme-text">
<li>
<button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="light" aria-pressed="false">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#sun-fill"></use></svg>
Light
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
<li>
<button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="dark" aria-pressed="false">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#moon-stars-fill"></use></svg>
Dark
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
<li>
<button type="button" class="dropdown-item d-flex align-items-center active" data-bs-theme-value="auto" aria-pressed="true">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#circle-half"></use></svg>
Auto
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
</ul>
</div>
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
<symbol id="arrow-right-circle" viewBox="0 0 16 16">
<path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0zM4.5 7.5a.5.5 0 0 0 0 1h5.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H4.5z"/>
</symbol>
<symbol id="bootstrap" viewBox="0 0 118 94">
<title>Bootstrap</title>
<path fill-rule="evenodd" clip-rule="evenodd" d="M24.509 0c-6.733 0-11.715 5.893-11.492 12.284.214 6.14-.064 14.092-2.066 20.577C8.943 39.365 5.547 43.485 0 44.014v5.972c5.547.529 8.943 4.649 10.951 11.153 2.002 6.485 2.28 14.437 2.066 20.577C12.794 88.106 17.776 94 24.51 94H93.5c6.733 0 11.714-5.893 11.491-12.284-.214-6.14.064-14.092 2.066-20.577 2.009-6.504 5.396-10.624 10.943-11.153v-5.972c-5.547-.529-8.934-4.649-10.943-11.153-2.002-6.484-2.28-14.437-2.066-20.577C105.214 5.894 100.233 0 93.5 0H24.508zM80 57.863C80 66.663 73.436 72 62.543 72H44a2 2 0 01-2-2V24a2 2 0 012-2h18.437c9.083 0 15.044 4.92 15.044 12.474 0 5.302-4.01 10.049-9.119 10.88v.277C75.317 46.394 80 51.21 80 57.863zM60.521 28.34H49.948v14.934h8.905c6.884 0 10.68-2.772 10.68-7.727 0-4.643-3.264-7.207-9.012-7.207zM49.948 49.2v16.458H60.91c7.167 0 10.964-2.876 10.964-8.281 0-5.406-3.903-8.178-11.425-8.178H49.948z"></path>
</symbol>
</svg>
<nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
<div class="container-fluid">
<a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="magick-navbars">
<ul class="navbar-nav me-auto mb-2 mb-md-0">
<li class="nav-item">
<a class="nav-link " href="../../www/download.html">Download</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../../www/command-line-tools.html">Tools</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../../www/command-line-processing.html">CLI</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../../www/develop.html">Develop</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
</li>
<li class="nav-item">
<iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
</li>
</ul>
<form class="d-flex form-inline" action="https://imagemagick.org/script/search.php">
<input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
<button class="btn btn-outline-success" type="submit" name="sa">Search</button>
</form>
</div>
</div>
</nav>
<div class="col-lg-8 mx-auto p-4 py-md-5 text-body-secondary">
<header class="d-flex align-items-center pb-3 mb-5 border-bottom">
<a href="../../" class="d-flex align-items-center text-decoration-none">
<h1 class="fs-4">MagickCore, C API: Working with Image Lists</h1>
</a>
</header>
<main class="container">
<h1 class="text-center">List</h1>
<div class="btn-group">
<button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
Select API Method
</button>
<ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
<li><a href="list.html#AppendImageToList">AppendImageToList</a></li>
<li><a href="list.html#CloneImageList">CloneImageList</a></li>
<li><a href="list.html#CloneImages">CloneImages</a></li>
<li><a href="list.html#DeleteImageFromList">DeleteImageFromList</a></li>
<li><a href="list.html#DeleteImages">DeleteImages</a></li>
<li><a href="list.html#DestroyImageList">DestroyImageList</a></li>
<li><a href="list.html#DuplicateImages">DuplicateImages</a></li>
<li><a href="list.html#GetFirstImageInList">GetFirstImageInList</a></li>
<li><a href="list.html#GetImageFromList">GetImageFromList</a></li>
<li><a href="list.html#GetImageIndexInList">GetImageIndexInList</a></li>
<li><a href="list.html#GetImageListLength">GetImageListLength</a></li>
<li><a href="list.html#GetLastImageInList">GetLastImageInList</a></li>
<li><a href="list.html#GetNextImageInList">GetNextImageInList</a></li>
<li><a href="list.html#GetPreviousImageInList">GetPreviousImageInList</a></li>
<li><a href="list.html#ImageListToArray">ImageListToArray</a></li>
<li><a href="list.html#InsertImageInList">InsertImageInList</a></li>
<li><a href="list.html#NewImageList">NewImageList</a></li>
<li><a href="list.html#PrependImageToList">PrependImageToList</a></li>
<li><a href="list.html#RemoveImageFromList">RemoveImageFromList</a></li>
<li><a href="list.html#RemoveFirstImageFromList">RemoveFirstImageFromList</a></li>
<li><a href="list.html#RemoveLastImageFromList">RemoveLastImageFromList</a></li>
<li><a href="list.html#ReplaceImageInList">ReplaceImageInList</a></li>
<li><a href="list.html#ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a></li>
<li><a href="list.html#ReverseImageList">ReverseImageList</a></li>
<li><a href="list.html#SpliceImageIntoList">SpliceImageIntoList</a></li>
</ul>
</div>
<br/>
<br/>
<div class="magick-header">
<h2><a href="../../api/MagickCore/list_8c.html" id="AppendImageToList">AppendImageToList</a></h2>
<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>
<p>The format of the AppendImageToList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>AppendImageToList(Image *images,const Image *image)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list to be appended to. </dd>
<dd> </dd>
<dt>image</dt>
<dd>the appended image or image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="CloneImageList">CloneImageList</a></h2>
<p>CloneImageList() returns a duplicate of the image list.</p>
<p>The format of the CloneImageList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *CloneImageList(const Image *images,ExceptionInfo *exception)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
<dt>exception</dt>
<dd>return any errors or warnings in this structure. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="CloneImages">CloneImages</a></h2>
<p>CloneImages() clones one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
<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 referred to multiple times to clone them multiple times. Images referred beyond the available number of images in list are ignored.</p>
<p>Images referenced may be reversed, and results in a clone of those images also being made with a reversed order.</p>
<p>The format of the CloneImages method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *CloneImages(const Image *images,const char *scenes,
ExceptionInfo *exception)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image sequence. </dd>
<dd> </dd>
<dt>scenes</dt>
<dd>This character string specifies which scenes to clone (e.g. 1,3-5,7-3,2). </dd>
<dd> </dd>
<dt>exception</dt>
<dd>return any errors or warnings in this structure. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="DeleteImageFromList">DeleteImageFromList</a></h2>
<p>DeleteImageFromList() deletes an image from the list. List pointer is moved to the next image, if one is present. See RemoveImageFromList().</p>
<p>The format of the DeleteImageFromList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>DeleteImageFromList(Image **images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="DeleteImages">DeleteImages</a></h2>
<p>DeleteImages() deletes one or more images from an image sequence, using a comma separated list of image numbers or ranges.</p>
<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 referred to multiple times without problems. Image referred beyond the available number of images in list are ignored.</p>
<p>If the referenced images are in the reverse order, that range will be completely ignored, unlike CloneImages().</p>
<p>The format of the DeleteImages method is:</p>
<pre class="bg-light text-dark mx-4"><samp>DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image sequence. </dd>
<dd> </dd>
<dt>scenes</dt>
<dd>This character string specifies which scenes to delete (e.g. 1,3-5,-2-6,2). </dd>
<dd> </dd>
<dt>exception</dt>
<dd>return any errors or warnings in this structure. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="DestroyImageList">DestroyImageList</a></h2>
<p>DestroyImageList() destroys an image list.</p>
<p>The format of the DestroyImageList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *DestroyImageList(Image *image)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image sequence. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="DuplicateImages">DuplicateImages</a></h2>
<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>
<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 referred to multiple times without problems. Image referred beyond the available number of images in list are ignored.</p>
<p>The format of the DuplicateImages method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *DuplicateImages(Image *images,const size_t number_duplicates,
const char *scenes,ExceptionInfo *exception)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image sequence. </dd>
<dd> </dd>
<dt>number_duplicates</dt>
<dd>duplicate the image sequence this number of times. </dd>
<dd> </dd>
<dt>scenes</dt>
<dd>This character string specifies which scenes to duplicate (e.g. 1,3-5,-2-6,2). </dd>
<dd> </dd>
<dt>exception</dt>
<dd>return any errors or warnings in this structure. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="GetFirstImageInList">GetFirstImageInList</a></h2>
<p>GetFirstImageInList() returns a pointer to the first image in the list.</p>
<p>The format of the GetFirstImageInList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *GetFirstImageInList(const Image *images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="GetImageFromList">GetImageFromList</a></h2>
<p>GetImageFromList() returns an image at the specified index from the image list. Starting with 0 as the first image in the list.</p>
<p>A negative offset will return the image from the end of the list, such that an index of -1 is the last image.</p>
<p>If no such image exists at the specified offset a NULL image pointer is returned. This will only happen if index is less that the negative of the list length, or larger than list length -1. EG: ( -N to N-1 )</p>
<p>The format of the GetImageFromList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *GetImageFromList(const Image *images,const ssize_t index)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
<dt>index</dt>
<dd>the position within the list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="GetImageIndexInList">GetImageIndexInList</a></h2>
<p>GetImageIndexInList() returns the offset in the list of the specified image.</p>
<p>The format of the GetImageIndexInList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>ssize_t GetImageIndexInList(const Image *images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="GetImageListLength">GetImageListLength</a></h2>
<p>GetImageListLength() returns the length of the list (the number of images in the list).</p>
<p>The format of the GetImageListLength method is:</p>
<pre class="bg-light text-dark mx-4"><samp>size_t GetImageListLength(const Image *images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="GetLastImageInList">GetLastImageInList</a></h2>
<p>GetLastImageInList() returns a pointer to the last image in the list.</p>
<p>The format of the GetLastImageInList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *GetLastImageInList(const Image *images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="GetNextImageInList">GetNextImageInList</a></h2>
<p>GetNextImageInList() returns the next image in the list.</p>
<p>The format of the GetNextImageInList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *GetNextImageInList(const Image *images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="GetPreviousImageInList">GetPreviousImageInList</a></h2>
<p>GetPreviousImageInList() returns the previous image in the list.</p>
<p>The format of the GetPreviousImageInList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *GetPreviousImageInList(const Image *images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="ImageListToArray">ImageListToArray</a></h2>
<p>ImageListToArray() is a convenience method that converts an image list to a sequential array, with a NULL image pointer at the end of the array.</p>
<p>The images remain part of the original image list, with the array providing an alternative means of indexing the image array.</p>
<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>
<p>The format of the ImageListToArray method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image list. </dd>
<dd> </dd>
<dt>exception</dt>
<dd>return any errors or warnings in this structure. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="InsertImageInList">InsertImageInList</a></h2>
<p>InsertImageInList() insert the given image or image list, into the first image list, immediately AFTER the image pointed to. The given image list pointer is left unchanged unless previously empty.</p>
<p>The format of the InsertImageInList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>InsertImageInList(Image **images,Image *insert)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list to insert into. </dd>
<dd> </dd>
<dt>insert</dt>
<dd>the image list to insert. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="NewImageList">NewImageList</a></h2>
<p>NewImageList() creates an empty image list.</p>
<p>The format of the NewImageList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *NewImageList(void)
</samp></pre>
<h2><a href="../../api/MagickCore/list_8c.html" id="PrependImageToList">PrependImageToList</a></h2>
<p>PrependImageToList() prepends the image to the beginning of the list.</p>
<p>The format of the PrependImageToList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>PrependImageToList(Image *images,Image *image)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
<dt>image</dt>
<dd>the image. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="RemoveImageFromList">RemoveImageFromList</a></h2>
<p>RemoveImageFromList() removes and returns the image pointed to.</p>
<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>
<p>The format of the RemoveImageFromList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *RemoveImageFromList(Image **images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="RemoveFirstImageFromList">RemoveFirstImageFromList</a></h2>
<p>RemoveFirstImageFromList() removes and returns the first image in the list.</p>
<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>
<p>The format of the RemoveFirstImageFromList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *RemoveFirstImageFromList(Image **images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="RemoveLastImageFromList">RemoveLastImageFromList</a></h2>
<p>RemoveLastImageFromList() removes and returns the last image from the list.</p>
<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>
<p>The format of the RemoveLastImageFromList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *RemoveLastImageFromList(Image **images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="ReplaceImageInList">ReplaceImageInList</a></h2>
<p>ReplaceImageInList() replaces an image in the list with the given image, or list of images. Old image is destroyed.</p>
<p>The images list pointer is set to point to the first image of the inserted list of images.</p>
<p>The format of the ReplaceImageInList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>ReplaceImageInList(Image **images,Image *replace)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the list and pointer to image to replace </dd>
<dd> </dd>
<dt>replace</dt>
<dd>the image or image list replacing the original </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="ReplaceImageInListReturnLast">ReplaceImageInListReturnLast</a></h2>
<p>ReplaceImageInListReturnLast() is exactly as ReplaceImageInList() except the images pointer is set to the last image in the list of replacement images.</p>
<p>This allows you to simply use GetNextImageInList() to go to the image that follows the just replaced image, even if a list of replacement images was inserted.</p>
<p>The format of the ReplaceImageInList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>ReplaceImageInListReturnLast(Image **images,Image *replace)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the list and pointer to image to replace </dd>
<dd> </dd>
<dt>replace</dt>
<dd>the image or image list replacing the original </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="ReverseImageList">ReverseImageList</a></h2>
<p>ReverseImageList() reverses the order of an image list. The list pointer is reset to that start of the re-ordered list.</p>
<p>The format of the ReverseImageList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>void ReverseImageList(Image **images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="SpliceImageIntoList">SpliceImageIntoList</a></h2>
<p>SpliceImageIntoList() removes 'length' images from the list and replaces them with the specified splice. Removed images are returned.</p>
<p>The format of the SpliceImageIntoList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>SpliceImageIntoList(Image **images,const size_t,
const Image *splice)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
<dt>length</dt>
<dd>the length of the image list to remove. </dd>
<dd> </dd>
<dt>splice</dt>
<dd>Replace the removed image list with this list. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickCore/list_8c.html" id="SplitImageList">SplitImageList</a></h2>
<p>SplitImageList() splits an image into two lists, after given image The list that was split off is returned, which may be empty.</p>
<p>The format of the SplitImageList method is:</p>
<pre class="bg-light text-dark mx-4"><samp>Image *SplitImageList(Image *images)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>images</dt>
<dd>the image list. </dd>
<dd> </dd>
</dl>
</div>
</div>
</main><!-- /.container -->
<footer class="py-5 text-center text-body-secondary bg-body-tertiary">
<div class="container-fluid">
<a href="../../www/security-policy.html">Security</a> •
<a href="../../www/news.html">News</a>
<a href="list.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a>
<a href="../../www/links.html">Related</a> •
<a href="../../www/sitemap.html">Sitemap</a>
<br/>
<a href="../../www/support.html">Sponsor</a> •
<a href="../../www/cite.html">Cite</a> •
<a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> •
<a href="../../www/contact.html">Contact Us</a>
<br/>
<a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
<a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
<br/>
<small>Copyright © 1999 ImageMagick Studio LLC</small>
</div>
</footer>
</div>
<!-- Javascript assets -->
<script src="../../assets/magick.js" ></script>
</body>
</html>