ImageGear for C and C++ on Windows v19.4 - Updated
IG_DIB_resolution_units_get
API Reference Guide > Core Component API Reference > Core Component Functions Reference > DIB Functions > IG_DIB_resolution_units_get

This function has been deprecated and will be removed from the public API in a future release. Please use IG_DIB_resolution_get or IG_image_resolution_get instead.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_DIB_resolution_units_get(
        LPAT_MODE lpnResUnits
);

Arguments:

Name Type Description
lpnResUnits LPAT_MODE Pointer to AT_MODE where to return current identifier of resolution units.

Return Value:

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:

None

Example:

 
Copy Code
HIGEAR hIGear;           /* HIGEAR handle of image */
AT_MODE nResUnits;
. . .IG_DIB_resolution_units_get( &nResUnits );. . .

Remarks:

ImageGear allows you to store the DIB resolution - biXPelsPerMeter and biYPelsPerMeter fields of AT_DIB structure - in different units depending on a global parameter; this function allows you to get the current value of this parameter. Valid values are IG_RESOLUTION_INCHES and IG_RESOLUTION_METERS. The default value is IG_RESOLUTION_METERS.