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

IMAGICK.GETITERATORINDEX(3)						 1					       IMAGICK.GETITERATORINDEX(3)

Imagick::getIteratorIndex - Gets the index of the current active image

SYNOPSIS

       int Imagick::getIteratorIndex (void  )

DESCRIPTION

	Returns  the  index  of  the current active image within the Imagick object. This method is available if Imagick has been compiled against
       ImageMagick version 6.2.9 or newer.

RETURN VALUES

	Returns an integer containing the index of the image in the stack.

ERRORS
/EXCEPTIONS
	Throws ImagickException on error.

EXAMPLES

       Example #1

	      Using Imagick.getIteratorIndex(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.setIteratorIndex(3), Imagick.getImageIndex(3), Imagick.setImageIndex(3).

PHP Documentation Group 											       IMAGICK.GETITERATORINDEX(3)