### QPx_CreateImageFileThumbnail

QPx_CreateImageFileThumbnail(sourceFilePath; thumbnailPict; targetWidth; targetHeight; thumbnailDepth; thumbnailOptions):error
| sourceFilePath | Text | Full path to image file
| thumbnailPict | Picture | The thumbnail picture
| targetWidth | Longint | Target width of thumbnail
| targetHeight | Longint | Target height of thumbnail
| thumbnailDepth | Longint | Thumbnail depth (optional)
| thumbnailOptions | Longint | Thumbnail options (optional)
| error | Longint | Error result

Creates a high quality thumbnail from an image file and stores it in a 4D picture.

The image file is specified by imagePath. If imagePath is empty, QPix presents a file selection dialog where the user can preview and select an image file. If the user selects a file, its full pathname is returned in imagePath, otherwise error qpx_userCancelErr is returned.

The thumbnail is returned in the thumbnailPict picture variable.

Target dimensions for the thumbnail are specified by targetWidth and targetHeight. These need not be proportional to the original image dimensions; QPix will automatically scale down the image proportionally to fit in the designated target dimensions. This command cannot be used for scaling images up.

Thumbnail pixel depth is specified in the thumbnailDepth parameter. The pixelDepth parameter must be in range of 0..40 (values greater than 32 mean grayscale). If omitted or equal to 0, QPix will use the original pixel depth instead.

The thumbnailOptions optional parameter can be used to specify additional options for the thumbnail creation. The following constants can be compined with bitwise "or".

qpx_ThumbWithProgress | 0x0001 | Display progress dialog during long thumbnail creation operations.
qpx_ThumbStandardQuality | 0x0004 | Create a standard quality thumbnail. Faster than the default high quality operation.

Note: This command is a replacement for the old QPx_GetImageFileThumbnail command. The QPx_GetImageFileThumbnail command is obsolete and has been renamed to QPxObs_GetImageFileThumbnail.

Related commands

QPx_GetImageFileEmbeddedThumb | Reads the embedded thumbnail from an image file

QPix © Escape
Generated by QDoc 2.8 on Wed, Feb 17, 2010 17:43:01