ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_display_option_get

This function allows you to get the current display option settings for either a specific HIGEAR image or to get the settings that will be inherited by each new HIGEAR image.


Copy Code
AT_ERRCOUNT ACCUAPI IG_display_option_get ( 
        HIGEAR hIGear, 
        AT_MODE nOption, 
        LPVOID lpOption, 
        LPVOID lpReserved


Name Type Description
hIGear HIGEAR HIGEAR handle of image, or NULL.
nOption AT_MODE A integer of type AT_MODE that tells ImageGear what type of display option for which to return a value. The options are defined in accucnst.h and their names begin with IG_DISPLAY_OPTION_.
lpOption LPVOID A long pointer to VOID data returned as display option data.
lpReserved LPVOID This argument is reserved for future use. Please set to NULL for now.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.


The value that you set for hIGear determines whether the option settings will be retrieved from a specific image or a global setting for all new HIGEAR images. If you set hIGear to a specific image, the settings for that image will be returned. If you set hIGear to NULL, global settings for all new HIGEAR images will be returned.

See the description under IG_display_option_set() for more details about the display settings.
Is this page helpful?
Yes No
Thanks for your feedback.