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

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

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_image_control_get(
       AT_MODE nOption,
       LPVOID lpData
);

Arguments:

Name Type Description
nOption AT_MODE Image option ID.
lpData LPVOID Reference to option data associated with the option ID.

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.

Sample:

C Filter, C Multimedia

Remarks:

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

This function retrieves the properties associated with the specified option ID.

See enumControlOpt for further information on image option IDs.

To determine the number of errors currently on the error stack use IG_error_check. After fetching all error information you need using IG_error_get, use IG_error_clear to clear the stack.