CreatePreviewFile

All Editions $image\bltlrgss.gif$ Example

The CreatePreviewFile transaction creates a thumbnail of the specified raster or vector image and places that preview in a file. The preview is limited in size to 320-by-320 pixels.

Type XTYP_EXECUTE

Syntax [CreatePreviewFile(docwinID, xPixels, yPixels, bColor, bAsDisplayed, formatID, "fileName")]

Parameter	Data type	Values	Meaning
docwinID	DWORD	0 \| docwinID	active \| specific
xPixels	WORD	1 to 320, inclusive	width of the preview
yPixels	WORD	1 to 320, inclusive	height of the preview
bColor	BOOL	0 1	create bilevel preview create color preview (if original was color)
bAsDisplayed	BOOL	0 1	preview of full page preview of image as displayed
formatID	WORD	File Format IDs	identifier for the required format. See Remarks.
fileName	string	file name including path of the output preview file

Remarks

With the View edition of Imagenation, only the following can be used as formatID: 7 (BMP), 6 (PCX), 15 (TIFF--bilevel only), 12 (TIFF--bilevel only), 69 (JFIF--color only), and 50 (JFIF--color only).

Release information

Added in Release 4.20.