fpCreateThumbnailForFile()
This functions converts a source file to an output PNG thumbnail file.
Syntax
KVPDFState pascal fpCreateThumbnailForFile( const KVPDFContext context, const char* const pszInFileName, const char* const pszOutFileName, const unsigned int widthPixels, const unsigned int heightPixels, const KVPDFThumbnailOptions options)
Arguments
|
|
A context value obtained by using fpInit(). |
|
|
A null-terminated C string that contains the path of the file to export to PNG. |
pszOutFileName
|
A null-terminated C string that contains the full file path where the export process must create the PNG. This value cannot be the current working directory. |
widthPixels
|
The width of the output bounding box in pixels. |
heightPixels
|
The height of the output bounding box in pixels. |
options
|
A KVPDFThumbnailOptions structure. Initialize a KVPDFThumbnailOptions structure with the KVStructInit() macro, and then modify the structure as necessary. |
Returns
- If the call is successful, a
KVPDFStatestructure witheErrorCodeset toKVERR_Success. - If the call is unsuccessful, a
KVPDFStatestructure that indicates the reason for the error.
Discussion
-
You cannot create PNG files in the current working directory.
-
If the target PNG file exists, this function overwrites it if possible.
-
On Windows systems, specify the paths in the local Windows code page.
-
You must initialize the options structure by using the
KVStructInit()macro. -
The output thumbnail is created to fit in the bounding box that you specify with
widthPixelsandheightPixels, but it maintains the correct aspect ratio. -
Usage of this function is licensed separately.
-
On Windows,
pszInFileNameandpszOutFileNamemust be in the local Windows code page.