ImageGear for C and C++ on Linux v18.8 - Updated
IG_load_extra_mode_set
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Load Functions > IG_load_extra_mode_set

This function instructs ImageGear to load or ignore extra channels when loading an image that contains any extra channels.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_load_extra_mode_set(
   enumIGExtraMode Mode
);

Arguments:

Name Type Description
Mode enumIGExtraMode IG_EXTRA_MODE_KEEP (default) to load Extra channel if it is present; IG_EXTRA_MODE_IGNORE to ignore Extra channel. See enumIGExtraMode.

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.

Example:

 
Copy Code
AT_ERRCOUNT nErrcount = IG_load_extra_mode_set(IG_EXTRA_MODE_KEEP);

Remarks:

See also IG_load_extra_mode_get() function.