imagick.setiteratorindex(3) php man page | unix.com

IMAGICK.SETITERATORINDEX(3)						 1					       IMAGICK.SETITERATORINDEX(3)

Imagick::setIteratorIndex - Set the iterator position

SYNOPSIS
       bool Imagick::setIteratorIndex (int  $index)

DESCRIPTION
	Set  the  iterator to the position in the image list specified with the index parameter. This method is available if Imagick has been com-
       piled against ImageMagick version 6.2.9 or newer.

PARAMETERS
	      o $index
		- The position to set the iterator to

RETURN VALUES
	Returns TRUE on success.

EXAMPLES
       Example #1

	      Using Imagick.setIteratorIndex(3):

	       Create images, set and get the iterator index

	      <?php
	      $im = new Imagick();
	      $im->newImage(100, 100, new ImagickPixel("red"));
	      $im->newImage(100, 100, new ImagickPixel("green"));
	      $im->newImage(100, 100, new ImagickPixel("blue"));

	      $im->setIteratorIndex(1);
	      echo $im->getIteratorIndex();
	      ?>

SEE ALSO
       Imagick.getIteratorIndex(3), Imagick.getImageIndex(3), Imagick.setImageIndex(3).

PHP Documentation Group 											       IMAGICK.SETITERATORINDEX(3)