QPx_GetAreaImageFile

QPx_GetAreaImageFile(areaRef; imagePath):error
areaRef Longint QPix area reference
imagePath Text Path of image file being displayed
error Longint Error result

Returns the full pathname of the image file currently being displayed in a QPix plug-in area.

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

The image file being displayed is returned in imagePath. If areaRef is not currently displaying an image file, imagePath is set to empty and the qpx_paramErr error code is returned.

Example

  `Get the full pathname of the image file displayed in area
 
C_LONGINT($error)
C_TEXT($imagePath)
 
$error:=QPx_GetAreaImageFile (gQPixArea;$imagePath)
 
If ($error=qpx_noErr)
 
   `$imagePath contains the pathname
 
End if

Related commands

QPx_SetAreaImageFile Displays an image file in a QPix area

QPix © Escape
Generated by QDoc 2.8 on Wed, Feb 17, 2010 17:44:21