<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set the iterator position</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.setinterlacescheme.html">Imagick::setInterlaceScheme</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setlastiterator.html">Imagick::setLastIterator</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.setiteratorindex" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::setIteratorIndex</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::setIteratorIndex</span> — <span class="dc-title">Set the iterator position</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.setiteratorindex-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::setIteratorIndex</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
)</div>
<p class="para rdfs-comment">
Set the iterator to the position in the image list specified with the index parameter.
This method is available if Imagick has been compiled against ImageMagick version 6.2.9 or newer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.setiteratorindex-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">index</code></em></span>
<dd>
<p class="para">
The position to set the iterator to
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.setiteratorindex-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.setiteratorindex-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3342">
<p><strong>Example #1 Using <span class="function"><strong>Imagick::setIteratorIndex()</strong></span>:</strong></p>
<div class="example-contents"><p>
Create images, set and get the iterator index
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$im </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">newImage</span><span style="color: #007700">(</span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">, new </span><span style="color: #0000BB">ImagickPixel</span><span style="color: #007700">(</span><span style="color: #DD0000">"red"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">newImage</span><span style="color: #007700">(</span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">, new </span><span style="color: #0000BB">ImagickPixel</span><span style="color: #007700">(</span><span style="color: #DD0000">"green"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">newImage</span><span style="color: #007700">(</span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">, new </span><span style="color: #0000BB">ImagickPixel</span><span style="color: #007700">(</span><span style="color: #DD0000">"blue"</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">setIteratorIndex</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">getIteratorIndex</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-imagick.setiteratorindex-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="imagick.getiteratorindex.html" class="function" rel="rdfs-seeAlso">Imagick::getIteratorIndex()</a> - Gets the index of the current active image</span></li>
<li class="member"> <span class="function"><a href="imagick.getimageindex.html" class="function" rel="rdfs-seeAlso">Imagick::getImageIndex()</a> - Gets the index of the current active image</span></li>
<li class="member"> <span class="function"><a href="imagick.setimageindex.html" class="function" rel="rdfs-seeAlso">Imagick::setImageIndex()</a> - Set the iterator position</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.setinterlacescheme.html">Imagick::setInterlaceScheme</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setlastiterator.html">Imagick::setLastIterator</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
