ILTStlImgWrt Interface

Data Types

1. File Flags

#define SHOWPROG 0x01
#define SHOWQFACTOR 0x02
#define SHOWMULTIPAGE 0x04
#define SHOWSTAMP 0x08
#define LOSSLESS_JPEG 0x10

Describe possible values for the InfoFileTypeFlags property and the InfoFileSubTypeFlags property listed in the Interface Properties section below.

2. File Save Options

typedef [v1_enum] enum FileSaveOptions 
{ 
   SAVE_OPTION_OVERWRITE = 1, 
   SAVE_OPTION_SKIP = 2, 
   SAVE_OPTION_USE_NEXT_NAME = 4, 
   SAVE_OPTION_APPLYTOALL = 8, 
} FileSaveOptions; 

Describes possible options when trying to save to a file that already exists.

Enumeration Description
SAVE_OPTION_OVERWRITE Save the current frame over the existing file if it currently exists.
SAVE_OPTION_SKIP Skip saving the current frame if the file name currently exists.
SAVE_OPTION_USE_NEXT_NAME Generate the next file name if the file name currently exists.
SAVE_OPTION_APPLYTOALL Apply the option to all subsequent cases.

3. File Format Types

These are the same as in the LEADTOOLS Raster Imaging documentation. For a complete list of format types, refer to Summary of All Supported Image File Formats

typedef [v1_enum] enum FileTypeConstants 
{ 
   SAVEFILE_CMP                   = 5, 
   SAVEFILE_LEAD1BIT = 26, 
   SAVEFILE_JFIF = 10, 
   SAVEFILE_CMW = 165, 
   SAVEFILE_J2K = 164, 
   SAVEFILE_TIF = 3, 
   SAVEFILE_GIF = 2, 
   SAVEFILE_PNG = 75, 
   SAVEFILE_CALS = 50, 
   SAVEFILE_CLP = 114, 
   SAVEFILE_DICOM_GRAY = 89, 
   SAVEFILE_DICOM_COLOR = 90, 
   SAVEFILE_CUT = 108, 
   SAVEFILE_EMF = 116, 
   SAVEFILE_EPS = 16, 
   SAVEFILE_EXIF = 96, 
   SAVEFILE_FAX_G4 = 68, 
   SAVEFILE_FLC = 134, 
   SAVEFILE_FPX = 80, 
   SAVEFILE_IMG = 52, 
   SAVEFILE_IFF_ILBM = 111, 
   SAVEFILE_ICA_G4 = 73, 
   SAVEFILE_INTERGRAPH_RLE = 122, 
   SAVEFILE_JBIG = 115, 
   SAVEFILE_MAC = 51, 
   SAVEFILE_PCT = 56, 
   SAVEFILE_RAWICA_G4 = 79, 
   SAVEFILE_MSP = 53, 
   SAVEFILE_OS2 = 14, 
   SAVEFILE_PBM_ASCII = 106, 
   SAVEFILE_PCX = 1, 
   SAVEFILE_PGM_ASCII = 104, 
   SAVEFILE_PPM_ASCII = 106, 
   SAVEFILE_PSD = 76, 
   SAVEFILE_RAW = 153, 
   SAVEFILE_SCT = 250, 
   SAVEFILE_SGI = 142, 
   SAVEFILE_RAS = 55, 
   SAVEFILE_TGA = 4, 
   SAVEFILE_WFX_G4 = 70, 
   SAVEFILE_BMP = 6, 
   SAVEFILE_WIN_CUR = 92, 
   SAVEFILE_WIN_ICO = 91, 
   SAVEFILE_WBMP = 170, 
   SAVEFILE_WMF = 15, 
   SAVEFILE_WPG = 54, 
   SAVEFILE_XBM = 110, 
   SAVEFILE_SMP = 256, 
   SAVEFILE_XPM = 109, 
   SAVEFILE_XWD10 = 132, 
   SAVEFILE_XWD11 = 133 
} FileTypeConstants; 

Enumeration Description
SAVEFILE_CMP LEAD CMP
SAVEFILE_LEAD1BIT LEAD 1 bit, lossless compression
SAVEFILE_JFIF Jpeg File Interchange Format
SAVEFILE_CMW Wavelet CMP
SAVEFILE_J2K Jpeg2000 stream
SAVEFILE_TIF Tagged Image File Format
SAVEFILE_GIF CompuServe GIF
SAVEFILE_PNG Portable Network Graphics
SAVEFILE_CALS CALS Raster file
SAVEFILE_CLP Microsoft Windows Clipboard Uncompressed
SAVEFILE_DICOM_GRAY Grayscale DICOM uncompressed
SAVEFILE_DICOM_COLOR Color DICOM uncompressed
SAVEFILE_CUT Dr. Halo.
SAVEFILE_EMF Windows Enhanced Metafile
SAVEFILE_EPS Encapsulated PostScript
SAVEFILE_EXIF Uncompressed RGB Exif file
SAVEFILE_FAX_G4 Raw FAX, compressed using CCITT group 4
SAVEFILE_FLC Flic Animation 256 color
SAVEFILE_FPX FlashPix, with no compression
SAVEFILE_IMG GEM Image
SAVEFILE_IFF_ILBM Interchange File - RLE Compressed.
SAVEFILE_ICA_G4 IOCA, compressed using CCITT group 4
SAVEFILE_INTERGRAPH_RLE ITG, Intergraph RLE compressed file
SAVEFILE_JBIG JBIG compression.
SAVEFILE_MAC MacPaint - Macintosh Paint
SAVEFILE_PCT Macintosh QuickDraw
SAVEFILE_RAWICA_G4 IOCA, compressed using CCITT group 3, 2 dimensions, without the MO:DCA wrapper.
SAVEFILE_MSP Microsoft Paint
SAVEFILE_OS2 OS/2 BMP version 1.x
SAVEFILE_PBM_ASCII Portable Bitmap - ASCII File
SAVEFILE_PCX ZSoft PCX
SAVEFILE_PGM_ASCII Portable Greymap - ASCII File
SAVEFILE_PPM_ASCII Portable Pixelmap - ASCII File
SAVEFILE_PSD Adobe Photoshop 3.0.
SAVEFILE_RAW Raw uncompressed data
SAVEFILE_SCT Scitex Continuous Tone Format
SAVEFILE_SGI Silicon Graphics Image uncompressed
SAVEFILE_RAS Sun Raster, uncompressed
SAVEFILE_TGA TARGA, uncompressed
SAVEFILE_WFX_G4 Winfax, compressed using CCITT group
SAVEFILE_BMP Windows BMP, with no compression
SAVEFILE_WIN_CUR Windows Cursor
SAVEFILE_WIN_ICO Windows Icon
SAVEFILE_WBMP Wireless Bitmap
SAVEFILE_WMF Windows Metafile
SAVEFILE_WPG WordPerfect Graphics Format
SAVEFILE_XBM XWindows XbitMap
SAVEFILE_SMP Xionics format
SAVEFILE_XPM XWindows XPicMap
SAVEFILE_XWD10 XWindows X Window dump, version 10
SAVEFILE_XWD11 XWindows X Window dump, version 11

4.Callback Options

typedef [v1_enum] enum SaveCallbackFlagsConstants 
{ 
   FRAME_OPTION_SAVE = 0, 
   FRAME_OPTION_SKIP = 1, 
   FRAME_OPTION_SKIP_AND_KEEP_NAME = 2 
} SaveCallbackFlagsConstants; 

Describes possible options when saving data using the callback.

Enumeration Description
FRAME_OPTION_SAVE The filter will save the frame.
FRAME_OPTION_SKIP The filter will not save the frame and will use the next output file name sequence for the next frame.
FRAME_OPTION_SKIP_AND_KEEP_NAME The filter will not save the frame and will use the current output file name sequence for the next frame.

Properties

Type Name Description
long BitsPerPixel Gets or sets the bits per pixel for the current file type. Changing this property will also change the FileTypeIndex, IsQFactorSupported, IsMultipageSupported and FileSubTypeIndex properties.
BSTR FileName Gets or sets the output file name. If the filter is loaded without specifying an output file name, a temporary file name is generated and the user is asked whether to use the temporary filename or not. If the user chooses not to use the temporary file name, the graph will not run.The user is responsible for freeing the allocated string.
long FileSubTypeIndex Gets or sets the current file subtype index. If the current file type has no subtypes, then trying to get or set this property will result in an E_INVALIDARG error.
FileTypeConstants FileTypeFormat Gets or sets the current file type format. Changing this value will also change the FileSubTypeIndex property. Generally, any change to this property will affect the following properties: FileTypeIndex, BitsPerPixel, IsQFactorSupported, IsMultipageSupported and FileSubTypeIndex. The file formats are the same as in the LEADTOOLS Raster Imaging documentation. For a complete list of format types, refer to Formats of Output Files
long FileTypeIndex Gets or sets the file type index. Any change in this value will affect the following properties: FileTypeFormat, BitsPerPixel, IsQFactorSupported, IsMultipageSupported, and FileSubTypeIndex.
FileSaveOptions HandleExistingFile Gets or sets the option for handling existing files (overwriting options) when saving. The SAVE_OPTION_APPLYTOALL can be ORed with the chosen option to apply it to all subsequent cases.
long InfoFileSubTypeFlags(long lFileTypeIndex) Read only. Gets the subtype flags for the file type and file subtype at the specified index. For a list of possible values, refer to File Flags. Please note that these values may be combined using OR.
long InfoFileSubTypeFormat(long lFileTypeIndex) Read only. Gets the subtype format for the file type and file subtype at the specified index.
long InfoFileSubTypesCount(long lFileTypeIndex) Read only. Gets the number of subtypes for the file type at the specified index.
BSTR InfoFileSubTypeString(long lFileSubTypeIndex) Read only. Gets the subtype string for the file type and file subtype at the specified index.The user is responsible for freeing the allocated string.
long InfoFileTypeBpp(long lIndex) Read only. Gets the bits per pixel for the file type at the specified index.
BSTR InfoFileTypeExt(long lIndex) Read only. Gets the extension string for the file type at the specified index.The user is responsible for freeing the allocated string.
long InfoFileTypeFlags(long lIndex) Read only. Gets the flags for the file type at the specified index. For a list of possible values, refer to File Flags. Please note that these values may be combined using OR.
FileTypeConstants InfoFileTypeFormat(long lFileTypeIndex) Read only. Gets the file type format for the specified file type index. The file formats are the same as in the LEADTOOLS Raster Imaging documentation. For a complete list of format types, refer to Formats of Output Files.
BSTR InfoFileTypeString(long lIndex) Read only. Gets the file type string for the specified file type index.The user is responsible for freeing the allocated string.
VARIANT_BOOL InputPinStreamingState Read only. Retrieves the streaming state of the input pin; VARIANT_TRUE if running and VARIANT_FALSE otherwise.
VARIANT_BOOL IsMultipageSupported (Read only) Indicates whether the current file type supports multipage files.
VARIANT_BOOL IsQFactorSupported (Read only) Indicates whether the current file type supports the QFactor for controlling the file compression.
long LastErrorCode (Read only) Gets the last error code. This will be one of the standard LEADTOOLS error codes. For a list of possible error codes, refer to Return Codes.
BSTR LastErrorString (Read only) Gets the last error string.The user is responsible for freeing the allocated string.
long NumberingDigits Gets or sets the number of digits to use in the output file sequence names.
VARIANT_BOOL PromptOverwrite Enables or disables prompting for the file overwrite options. Possible values are:
• VARIANT_TRUE - a dialog will be shown if the next file name to be used already exists. The dialog will offer the overwrite, skip, and use next available name options in addition to an apply for all option.
• VARIANT_FALSE - the option in the HandleExistingFile property will be used without asking.
long QFactor Gets or sets the QFactor for the current file type format.
VARIANT_BOOL SaveMultipage Enables or disables saving to a multipage file. This will only affect formats that support multipage files. See also the IsMultipageSupported property.
ILTStlImgWrtUserCallback SaveOptionsCallback Sets the callback object pointer.
long SupportedFileTypesCount Read only. Retrieves the number of file types that the filter can save. This can be used to loop through all the supported types getting information such as the string, the bits per pixel, the extension, etc. This can help you build your own user interface.
VARIANT_BOOL UseTempFileName Gets or sets a flag that indicates whether to use the temp file name if the user did not set the output file name in the FileName property. Possible values are:
• VARIANT_TRUE - the filter will create a temp filename and use it.
• VARIANT_FALSE - the filter will create a temp file and ask the user if he wants to save the frame using the temp filename.
long DialogParentWnd Gets or sets the window handle for the messages boxes and the prompt dialog.
VARIANT_BOOL EnableMessageBoxes Enables or disables the displaying of the messages boxes when an error occurred.
VARIANT_BOOL LoopOnMultipage Enables or disables looping on multipage files. This will only affect formats that support multipage files. See also the IsMultipageSupported property.

Methods

HRESULT ResetErrorCode()

Description

Resets the last error value to success.

Returns

Return Description
S_OK Successful.
Error code Otherwise.
Help Version 22.0.2022.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Filters C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.