IG_fltr_info

This function returns information about the format filter and its supported features.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_fltr_info_get( AT_MODE nFormatID, LPDWORD lpdwInfoFlags, LPCHAR lpShortName, DWORD dwSNameSize, LPCHAR lpFullName, DWORD dwFNameSize, LPCHAR lpDefExt, DWORD dwDefExtSize );

Arguments:

Name	Type	Description
nFormatID	AT_MODE	File format identifier. See enumIGFormats for possible values.
lpdwInfoFlags	LPDWORD	Pointer to a variable which will receive the format flags. Any combination of enumIGFltrFormatFlags values can be returned.
lpShortName	LPCHAR	Pointer to a byte array which will receive the zero-terminated string with the short file format name. Set to NULL if you do not need to obtain this information.
dwSNameSize	DWORD	Size of the lpShortName array in bytes.
lpFullName	LPCHAR	Pointer to a byte array which will receive the zero-terminated string with the full file format name. Set to NULL if you do not need to obtain this information.
dwFNameSize	DWORD	Size of the lpFullName array in bytes.
lpDefExt	LPCHAR	Pointer to a byte array which will receive the zero-terminated string with file masks such as *.tif separated by a semicolon (;). Set to NULL if you do not need to obtain this information.
dwDefExtSize	DWORD	Size of lpDefExt array in bytes.

Return Value:

Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

This function does not process image pixels.

Example:

	Copy Code
AT_CHAR shortName[_MAX_PATH]; AT_CHAR fullName[_MAX_PATH]; AT_CHAR defExt[_MAX_PATH]; DWORD dwFlags; AT_ERRCOUNT nErrCount; nErrCount = IG_fltr_info_get(IG_FORMAT_TIF, &dwFlags, shortName, sizeof(shortName), fullName, sizeof(fullName), defExt, sizeof(defExt)); // Output the filter info if(dwFlags & IG_FLTR_DETECTSUPPORT) printf("IG_FLTR_DETECTSUPPORT\n"); if(dwFlags & IG_FLTR_PAGEREADSUPPORT) printf("IG_FLTR_PAGEREADSUPPORT\n"); if(dwFlags & IG_FLTR_MPAGEREADPSUPPORT) printf("IG_FLTR_MPAGEREADPSUPPORT\n"); if(dwFlags & IG_FLTR_MPAGEWRITEPSUPPORT) printf("IG_FLTR_MPAGEWRITEPSUPPORT\n"); if(dwFlags & IG_FLTR_PAGEINSERTSUPPORT) printf("IG_FLTR_PAGEINSERTSUPPORT\n"); if(dwFlags & IG_FLTR_PAGEDELETESUPPORT) printf("IG_FLTR_PAGEDELETESUPPORT\n"); if(dwFlags & IG_FLTR_PAGESWAPSUPPORT) printf("IG_FLTR_PAGESWAPSUPPORT\n"); if(dwFlags & IG_FLTR_MPDATASUPPORT) printf("IG_FLTR_MPDATASUPPORT\n"); printf("Short name: %s\nFullName: %s\nDefault Extension: %s\n", shortName, fullName, defExt);

Copy Code

AT_CHAR shortName[_MAX_PATH];
AT_CHAR fullName[_MAX_PATH];
AT_CHAR defExt[_MAX_PATH];
DWORD dwFlags;

AT_ERRCOUNT nErrCount;
nErrCount = IG_fltr_info_get(IG_FORMAT_TIF, &dwFlags, shortName, sizeof(shortName),
    fullName, sizeof(fullName), defExt, sizeof(defExt));

// Output the filter info
if(dwFlags & IG_FLTR_DETECTSUPPORT)
    printf("IG_FLTR_DETECTSUPPORT\n");
if(dwFlags & IG_FLTR_PAGEREADSUPPORT)
    printf("IG_FLTR_PAGEREADSUPPORT\n");
if(dwFlags & IG_FLTR_MPAGEREADPSUPPORT)
    printf("IG_FLTR_MPAGEREADPSUPPORT\n");
if(dwFlags & IG_FLTR_MPAGEWRITEPSUPPORT)
    printf("IG_FLTR_MPAGEWRITEPSUPPORT\n");
if(dwFlags & IG_FLTR_PAGEINSERTSUPPORT)
    printf("IG_FLTR_PAGEINSERTSUPPORT\n");
if(dwFlags & IG_FLTR_PAGEDELETESUPPORT)
    printf("IG_FLTR_PAGEDELETESUPPORT\n");
if(dwFlags & IG_FLTR_PAGESWAPSUPPORT)
    printf("IG_FLTR_PAGESWAPSUPPORT\n");
if(dwFlags & IG_FLTR_MPDATASUPPORT)
    printf("IG_FLTR_MPDATASUPPORT\n");

printf("Short name: %s\nFullName: %s\nDefault Extension: %s\n", shortName, fullName, defExt);

Remarks:

This function returns a short format name - usually 3-4 chars (e.g., "TIFF"), full format name (e.g., "Tagged Image File Format"), and default file extensions separated by ";" (e.g., "*.tif;*.tiff").

See also the section Getting Information and Sorting Images.