QMedical Command Reference Area Frames

QMed_SetAreaFrameIndex

QMed_SetAreaFrameIndex(areaRef; frameIndex):error
areaRef Longint QMedical area reference
frameIndex Longint Frame index
error Longint Error result

Changes the current frame of the image currently assigned to a plug-in area.

The QMedical plug-in area is specified by areaRef. If areaRef is not a valid QMedical plug-in area reference, qmed_paramErr is returned.

Parameter frameIndex specifies the frame index.

Note 1: This command is similar to QMed_SetImageFrameIndex. The main difference is that here the plug-in area reference is used as a parameter instead of the image reference.

Note 2: 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_GetAreaFrameIndex Returns the current frame of the image currently assigned to a plug-in area
QMed_CountAreaFrames Returns the number of frames in the image currently assigned to a plug-in area

QMedical © Escape Information Services
Generated by QDoc 2.7 on Wed, Mar 24, 2004 17:00:37