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

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

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_DIB_resolution_units_set( 
        AT_MODE nDIBResUnits
);

Arguments:

Name Type Description
nDIBResUnits AT_MODE Value of type AT_MODE. Can be either IG_RESOLUTION_INCHES or IG_RESOLUTION_METERS.

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 nDIBResUnits
nDIBResUnits = IG_RESOLUTION_INCHES
...IG_DIB_resolution_units_set( nDIBResUnits );. . .

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 set the current value of this parameter.

Valid values are IG_RESOLUTION_INCHES and IG_RESOLUTION_METERS. The default value is IG_RESOLUTION_METERS.