SAVEDLGPARAMS

typedef struct _SAVEDLGPARAMS 
{ 
   L_UINT uStructSize; 
   L_TCHAR szFileName [L_MAXPATH]; 
   pBITMAPHANDLE pBitmap; 
   L_INT nBitsPerPixel; 
   L_INT nFormat; 
   L_INT nQFactor; 
   L_UINT uSaveMulti; 
   L_BOOL bSaveInterlaced; 
   L_INT nPasses; 
   L_BOOL bSaveWithStamp; 
   L_INT nStampBits; 
   L_INT nStampWidth; 
   L_INT nStampHeight; 
   L_INT nPageNumber; 
   L_UINT uFileTypeIndex; 
   L_UINT uSubTypeIndex; 
   FILEJ2KOPTIONS FileJ2KOptions; 
   LPFILESAVEFORMAT pFileFormats; 
   L_UINT uFileFormatsCount; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID *pHelpCallBackUserData; 
   FILEJBIG2OPTIONS FileJBIG2Options; 
   INITIALVIEWENUM InitialView; 
   PDFPROFILESENUM PDFProfiles; 
   L_BOOL bSaveBigTiff; 
} SAVEDLGPARAMS, * LPSAVEDLGPARAMS; 

The SAVEDLGPARAMS structure provides information used to initialize the dialog box created by the L_DlgSave function. After the user closes the dialog box, this structure is updated with information about the user's selections.

Members

uStructSize

Size of this structure, in bytes. Use the sizeof operator to calculate this value.

szFileName

Character string containing the name of the file to save.

pBitmap

Pointer to the bitmap handle that references the bitmap used for processing.

nBitsPerPixel

Value that indicates the number of bits per pixel to be used to save the image.

nFormat

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

nQFactor

This parameter is used when saving an image file as:

Qfactor is a number that determines the degree of loss in the compression process. For possible values, refer to Compression Quality Factors.

uSaveMulti

Data value indicating how to save a page to a multipage file. You can save multipage images in PCX, GIF, FlashPix, and most TIFF file formats (including JTIF, but excluding EXIF). Possible values are:

Value Meaning
MULTIPAGE_OPERATION_OVERWRITE [1] Overwrite the file.
MULTIPAGE_OPERATION_APPEND [2] Append page to the end of the file.
MULTIPAGE_OPERATION_REPLACE [3] Replace page. Refer to SAVEFILEOPTION.Flags.
MULTIPAGE_OPERATION_INSERT [4] Insert page. Refer to SAVEFILEOPTION.Flags.

bSaveInterlaced

Flag that indicates whether to save GIF files as interlaced. GIF files may be saved interlaced or non-interlaced. Selecting GIF as the format of the file to be saved, the user is given the option in the dialog of selecting interlaced or non-interlaced. Selecting interlaced will set this flag to TRUE. For more information, see Implementing GIF Features. Possible values are:

Value Meaning
TRUE Save GIF files as interlaced.
FALSE Save GIF files as non-interlaced.

nPasses

Value that indicates the number of passes (scans through the image) when loading or saving a progressive JPEG, LEAD CMP or PNG files. (This value is also used when loading, but not when saving, interlaced PNG files.)

Possible values when saving (whether progressive or not):

Value Meaning
> 1 Save the file as a progressive file with the specified number of passes.
1 Save a regular JPEG file with dynamically optimized Huffman tables (ie the Huffman tables are optimized for the image you are saving).

Use this for smaller file size (at the expense of speed). | | 0 | Save a regular JPEG file with static Huffman tables (ie the Huffman tables are the same for all images). | | < 0 | Save the file as a progressive file with the LEADTOOLS default number of passes. |

bSaveWithStamp

Value that indicates the status of the SaveStamp Box. If checked, a stamp of the image will be saved if the DLG_SAVE_AUTOPROCESS flag was set and the format supports stamps. Possible values are:

Value Meaning
TRUE Save the image with a stamp.
FALSE Save the image without a stamp.

nStampBits

Value that indicates the bits per pixel of the stamp image to save. A stamp is saved only if the ESO_SAVEWITHSTAMP flag is set in the SAVEFILEOPTION.Flags field, for formats that support stamps. Possible values are 8 or 24.

nStampWidth

Width, in pixels, of the stamp image to save. A stamp is saved only if the ESO_SAVEWITHSTAMP flag is set in the SAVEFILEOPTION.Flags field, in formats that support stamps. Possible values range from 1 to 255.

nStampHeight

Height, in pixels, of the stamp image to save. A stamp is saved only if the ESO_SAVEWITHSTAMP flag is set in the SAVEFILEOPTION.Flags field, in formats that support stamps. Possible values range from 1 to 255.

nPageNumber

Value that indicates the number of the page to replace or the number of the page in front of which to insert the page.

uFileTypeIndex

Value that indicates the file type. When the L_DlgSave function returns, this member will be updated with the file type entered by the user through the dialog. Set this member before calling L_DlgSave to initialize the dialog. For example, to set the initial selection on "LEAD (*.cmp)" format set this member to DLG_FF_SAVE_LEAD. For a list of possible values, refer to Customizing File Format Lists.

uSubTypeIndex

Value that indicates the file sub-type, if one exists. When the L_DlgSave function returns, this member will be updated with the file sub-type entered by the user through the dialog, if one exists. Set this member before calling L_DlgSave to initialize the dialog. For example, to set the initial selection to the "Progressive" subtype of the "LEAD (*.cmp)" file type, set this member to DLG_FF_SAVE_SUB_CMP_PROGRESSIVE. For a list of possible values, refer to Customizing File Format Lists.

FileJ2KOptions

A structure that contains the options to use when saving J2K or JP2 files.

pFileFormats

Pointer to an array of FILESAVEFORMAT structures that will indicate which formats, BPP, and subformats to include in the File Save Dialog. The order of the elements in the array indicates the order the items will appear in the FileType drop-down list box. Pass NULL to have LEADTOOLS add all supported formats, BPP, and subformats to the File Save Dialog. For more information on available file types, refer to Customizing File Format Lists.

uFileFormatsCount

The number of the items in pFileFormats. This member is ignored if pFileFormats is NULL. For more information on available file types, refer to Customizing File Format Lists.

uDlgFlags

User interface flags for this dialog, which determine the layout and action of the dialog. Possible values are:

pfnHelpCallback

Pointer to an optional help callback function. If you do not wish to provide help to this dialog, use NULL as the value of this parameter. To provide help to this dialog, use the function pointer as the value of this parameter. The callback function must adhere to the prototype described in LTCOMMDLGHELPCB.

pHelpCallBackUserData

Void pointer that you can use to pass one or more additional parameters that the callback function needs. To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pHelpCallBackUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. If the additional parameters are not needed, you can pass NULL in this parameter.

FileJBIG2Options

A structure that contains the options to use when saving JBIG2 files.

InitialView

Specifies how OpenFileDialog displays the items in the ListView control. For a list of possible values, refer to INITIALVIEWENUM.

PDFProfiles

Specifies the Specifies the PDF profile to be used when saving.  For a list of possible values, refer to PDFPROFILESENUM (For V16 only).

bSaveBigTiff

Flag that indicates whether to save TIFF files as BigTiff. Possible values are:

Value Meaning
TRUE Save the file as BigTIFF.
FALSE Do not save the file as BigTIFF.
Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Common Dialog C API Help