QPix Command Reference Graphics Importers

QPx_GetImporterImageIndex

QPx_GetImporterImageIndex(importerRef; imageIndex):error
importerRef Longint Graphics importer reference
imageIndex Longint Images index
error Longint Error result

Returns the current image index of multi-image files.

When working with multi-image files, all graphic importer commands apply to the "current image". The current image is identified by its index. The image index ranges from 1 to the number of images in the file. The default image index is 1.

The graphics importer instance is specified by importerRef. If importerRef is not a reference to a valid graphics importer instance, error qpx_paramErr is returned.

Parameter imageIndex receives the current image index.

Note: An image index value of zero (0) is usually equivalent to one (1), unless some importers treat the zero value in a special way.

Related commands

QPx_SetImporterImageIndex Changes the current image in a multi-image container
QPx_CountImporterImages Returns the number of images in a multi-image container

QPix © Escape Information Services
Generated by QDoc 2.6 on Thu, 2 May 2002 00:50:07 +0300