LFile::FileConvert

#include "ltwrappr.h"

static L_INT LFile::FileConvert(pszFileDst, pszFileSrc, nType, nWidth, nHeight, nBitsPerPixel, nQFactor, pLoadFileOption=NULL, pSaveFileOption=NULL, pFileInfo)

L_TCHAR * pszFileDst;

/* output file name */

L_TCHAR * pszFileSrc;

/* input file name */

L_INT nType;

/* output file format */

L_INT nWidth;

/* width of the new output file */

L_INT nHeight;

/* height of the new output file */

L_INT nBitsPerPixel;

/* output file pixel depth */

L_INT nQFactor;

/* quality factor */

pLOADFILEOPTION pLoadFileOption;

/* pointer to optional extended load options */

pSAVEFILEOPTION pSaveFileOption;

/* pointer to optional extended save options */

pFILEINFO pFileInfo;

/* pointer to a structure */

Converts an image file from one format to another, creating a new file in the new format.

Parameter

Description

pszFileDst

Character string containing the output file name.

pszFileSrc

Character string containing the input file name.

nType

Output file format. For valid values, refer to  Summary of File Formats.

nWidth

The new width of the output file. If this value is not 0, then the output file will be resized to the nWidth value. Use a value of 0 if you do not wish to resize the output file.

nHeight

The new height of the output file. If this value is not 0, then the output file will be resized to the nHeight value. Use a value of 0 if you do not wish to resize the output file.

nBitsPerPixel

The output file pixel depth. Note that not all bits per pixel are available to all file formats. For valid values, refer to  Summary of File Formats.

nQFactor

This parameter is used when saving an image file to FILE_CMP, FILE_JPEG, FILE_JPEG_411, FILE_JPEG_422, FILE_TIF_JPEG, FILE_TIF_JPEG_411, FILE_TIF_JPEG_422, FILE_FPX_JPEG_QFACTOR, and FILE_EXIF_JPEG. Q factor is a number that determines the degree of loss in the compression process.

 

For possible values, refer to Compression Quality Factors.

pLoadFileOption

Pointer to optional extended load options. Pass NULL to use the default load options.

pSaveFileOption

Pointer to optional extended save options. Pass NULL to use the default save options.

pFileInfo

Pointer to optional extended load options. Pass NULL to use the default load options.

 

If nothing is known about the file, pass NULL for this parameter, or declare a variable of type FILEINFO and set the FILEINFO.Flags to 0, then pass the address of the FILEINFO structure in this parameter. In this case, if the address of a FILEINFO structure is passed, the FILEINFO structure will be updated with the results of LFile::GetInfo.

 

If only the file type is known, set pFileInfo.Format to the file type and set pFileInfo.Flags to FILEINFO_FORMATVALID. This can also be done if LFile::GetInfo has been called previously, but values that affect the size of the image loaded have been changed (for example, by calling LFileSettings::SetPCDResolution or LFileSettings::SetWMFResolution). In this case the FILEINFO structure pointed to by pFileInfo will be updated with the results of LFile::GetInfo.

 

If LFile::GetInfo has been called prior to calling this function, and no changes have been made to the contents of the structure filled by LFile::GetInfo, then the address of the filled FILEINFO structure can be passed for this parameter. In this case, the FILEINFO.Flags member should be set to FILEINFO_INFOVALID. The LFile::GetInfo function will set the FILEINFO.Flags to FILEINFO_INFOVALID. In this case the load will be faster since this function does not have to query the file filters for the file type.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

If you convert to a lower bits-per-pixel format, this function optimizes the colors automatically. For example, when converting a 24-bit file (16 million colors) to an 8-bit file (256 colors) this function selects the best 256 colors to represent the 24-bit image.

Note that this is a high-level function that does conversion from all possible formats to all possible formats.

To update a status bar or detect a user interrupt during execution of this function, refer to LBase::EnableStatusCallBack.

Required DLLs and Libraries

LTFIL
File format DLLs

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

Class Members, LFile::SaveFile, LFile::TransformFile, LFile::Save

Topics:

Raster Image Functions: Saving Files

 

Raster Image Functions: Maintaining File Comments and Tags

 

Raster Image Functions: Low-Level Compression Functions

 

Raster Image Functions: Loading and Saving Stamp Images

 

Raster Image Functions: Redirecting Input and Output

 

Raster Image Functions: Input and Output

 

Loading and Saving Images

Example

For an example, refer to LFile::LoadBitmap.