LEADTOOLS Raster Imaging C++ Class Library Help > Classes and Member Functions > LFile > LFile Member Functions > LFile::SaveList |
#include "ltwrappr.h"
virtual L_INT LFile::SaveList(pList, nFormat, nBits=0, nQFactor=2, pSaveFileOption=NULL)
LBitmapList * pList; |
/* pointer to the LBitmapList object */ |
L_INT nFormat; |
/* output file format */ |
L_INT nBits; |
/* resulting file's pixel depth */ |
L_INT nQFactor; |
/* quality factor */ |
pSAVEFILEOPTION pSaveFileOption; |
/* pointer to optional extended save options */ |
Saves the specified list of bitmaps in a multipage file.
Parameter |
Description |
pList |
Pointer to the LBitmapList object that holds the list of bitmaps. |
nFormat |
Output file format. You can save multipage images in PCX, GIF, and most TIFF file formats (including JTIF, but excluding EXIF). For possible values, refer to Files To Be Included With Your Application. |
|
Single image formats are also valid (although only one image can be stored). |
nBits |
Resulting file's pixel depth. For possible values, refer to Formats of Output Files. If nBits is 0, the file will be stored using the closest BitsPerPixel value supported by that format. For example, if a file format supports 1, 4, and 24 BitsPerPixel, and LBitmapBase::GetBitsPerPixel returns 5, the file will be stored as 24 bit. Likewise, if LBitmapBase::GetBitsPerPixel returns 2, the file will be stored as 4 bit. |
nQFactor |
This parameter is used when saving an image to file format that supports quality factor (QFactor). QFactor is a number that determines the degree of loss in the compression process. |
|
For possible values, refer to Compression Quality Factors. |
pSaveFileOption |
Pointer to optional extended save options. Pass NULL to use the default save options. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Single-image formats are also valid for output, but only the first image in the list is saved.
Note: More options are available in the SAVEFILEOPTION structure.
This function supports signed data images, but only DICOM and TIFF formats support signed data. This function will return an error code if you attempt to save a signed image to a format other than DICOM or TIFF.
If the bitmap has a region, the region stored in the bitmap will be saved, if the image is saved as one of the TIFF file formats.
Required DLLs and Libraries
LTFIL For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64.
See Also
Functions: |
|
Topics: |
|
|
Example
For an example, refer to LFile::LoadBitmapList.