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

This function gets a ColorBook object with the specified index from the ColorBooks collection.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_colorbooks_colorbook_by_index_get(
        AT_UINT nIndex,
        HIGCOLORBOOK* lphColorBook
);

Arguments:

Name Type Description
nIndex AT_UINT Index of the requested ColorBook.
lphColorBook HIGCOLORBOOK* Obtained ColorBook object.

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.