ImageGear for C and C++ on Windows v19.1 - Updated
IG_gui_format_filter_get
API Reference Guide > GUI Component API Reference > GUI Component Functions Reference > Utility Functions > IG_gui_format_filter_get

This function is used to generate textual representation of file format IDs list.

Declaration:

 
Copy Code
VOID  ACCUAPI  IG_gui_format_filter_get(
        LPAT_MODE lpFormatList,
        UINT nFListSize,
        BOOL bShortName,
        LPBYTE lpFilter,
        UINT nFilterSize
);

Arguments:

Name Type Description
lpFormatList AT_MODE An array of IG_FORMAT_ constants. Please see accucnst.h file for the full list of these constants.
nFListSize UINT The number of elements in lpFormatList array.
bShortName BOOL If this argument is TRUE then short names of file formats are used in lpFilter list. If it is FALSE then long names are used.
lpFilter LPBYTE The list of formats with default extensions.
nFilterSize UINT The size of lpFilter buffer.

Return Value:

None

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

GUI Windows

Remarks:

The first argument is an array of IG_FORMAT_... constants. The second argument contains number of elements in lpFormatList array. The third argument is used to select either short or long name of file format. The lpFilter argument should contain buffer large enough to store the list of formats with default extensions. The format of this data is exact to be passed directly to standard OPEN or SAVE dialog with function GetOpenFileName as value of lpstrFilter field in OPENFILENAME structure.