QMed_SetImageFrameIndex(imageRef; frameIndex):error
imageRef Longint Reference to the image
frameIndex Longint Frame index
error Longint Error result

Changes the current frame index in the case of multi-frame images.

When working with multi-frame images all image commands commands apply to the "current frame". The current frame is identified by its index. The frame index ranges from 1 to the total number of frames in the image. The default frame index is 1.

The image is specified by imageRef. If imageRef is not a valid image, error qmed_paramErr is returned.

Parameter frameIndex specifies the frame index.

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

Related commands

QMed_GetImageFrameIndex Returns the current frame of a multi-frame image
QMed_CountImageFrames Returns the number of frames in a multi-frame image

QMedical © Escape
Generated by QDoc 2.8 on Wed, Jan 27, 2010 17:54:29