QPix Command Reference Image Area

QPx_ExportAreaImage

QPx_ExportAreaImage(areaRef; targetPath; targetType; exportSettings):error
areaRef Longint QPix area reference
targetPath Text Pathname to the target file
targetType String4 4-char image type identifier
exportSettings BLOB Export settings
error Longint Error result

Exports the image from a QPix plug-in area to an image file.

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 target (destination) file is specified by targetPath. The target file may not already exist, but its containing folder path must be valid. If targetPath points to an existing file, the latter will be replaced by the new file. If targetPath is empty, a file selection dialog is presented for the user to select the target directory and specify a file name.

The targetType parameter specifies the target file format. If targetPath is specified and targetType is passed an empty string, targetType defaults to "PICT". If targetPath is not specified, both the target path and type will have to be selected from the file selection dialog. In any other case, an error will be generated (qpx_ParamErr). If the user cancels the dialog, error qpx_userCancelErr is returned.

To get the list of avaliable export formats, call the QPx_GetExportTypes command. QPix defines the following constants for the export formats supported by QuickTime 4.x.

qpx_JPEGFile "JPEG" JPEG/JIFF file format
qpx_TIFFFile "TIFF" TIFF file format
qpx_PNGFile "PNGf" PNG file format
qpx_BMPFile "BMPf" BMP file format
qpx_PhotoshopFile "8BPS" Adobe Photoshop file format
qpx_PictureFile "PICT" Apple PICT file format
qpx_QTImageFile "qtif" QuickTime Image file format
qpx_TargaFile "TPIC" Truevision Targa file format
qpx_SGIImageFile ".SGI" Silicon Graphics SGI file format
qpx_MacPaintFile "PNTG" Apple MacPaint file format

The exportSettings parameter can be used to specify format-specific settings for the export operation, and to receive settings after a successful image export. Not all export formats support settings. If the specified export format does not support settings, this parameter is ignored. If an empty BLOB is passed, format-specific defaults are used.

Note: The exportSettings BLOB parameter must contain valid export settings. The structure of this BLOB is private to QuickTime and cannot be constructed or altered with 4D BLOB commands. To let the user modify the export settings, call the QPx_DoExportSettingsDialog command.

Example

  `Export the area image to TIFF
 
C_LONGINT($error)
C_TEXT($destPath)
C_BLOB($settings)
 
$destPath:="Macintosh HD:image.tiff"
 
$error:=QPx_ExportAreaImage (gQPixArea;$destPath;qpx_TIFFFile;$settings)
 

Related commands

QPx_GetExportTypes Returns the list of available export types
QPx_DoExportSettingsDialog Displays the export settings dialog for a specific file type

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