ImageGear for C and C++ on Windows v19.1 - Updated
IG_colorbook_color_by_index_get
API Reference Guide > Core Component API Reference > Core Component Functions Reference > ColorBook Functions > IG_colorbook_color_by_index_get

This function gets a color with the specified index from the color book.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_colorbook_color_by_index_get(
        HIGCOLORBOOK hColorBook,
        AT_UINT nIndex,
        HIGCOLORBOOKCOLOR* lphColorBookColor
);

Arguments:

Name Type Description
hColorBook HIGCOLORBOOK Color book object.
nIndex AT_UINT Index of the requested color in the color book.
hColorBookColor HIGCOLORBOOKCOLOR* Obtained ColorBook Color.

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.