ImageGear for C and C++ on Windows v19.1 - Updated
IG_image_compression_type_get
API Reference Guide > Core Component API Reference > Core Component Functions Reference > General Image Functions > IG_image_compression_type_get

This function returns the compression type used for storing the image indicated by hIGear.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_image_compression_type_get(
       HIGEAR hIGear,
       LPDWORD lpCompression
);

Arguments:

Name Type Description
hIGear HIGEAR HIGEAR handle of image.
lpCompression LPDWORD Pointer to a variable which will receive the compression type. See enumIGBiCompression for possible values.

Return Value:

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

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Sample:

MFC Multipage, Pixel Access, Legacy Pixel Access

Remarks:

ImageGear currently uses only two types of image storage (compression): "Run Ends" and "Standard". ImageGear always uses "Run Ends" compression for 1-bit images, and "Standard" (uncompressed) format for all other types of images. If the function returns any value other than IG_BI_RLE and IG_BI_EMPTY, this means that the DIB uses Standard storage format. This behavior is preserved for compatibility with previous versions of ImageGear.