ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Global Control Parameter Functions > IG_gctrl_item_by_index_get

This function is like IG_gctrl_item_get(), but returns information about parameter determined by given index in array.


Copy Code
AT_BOOL  ACCUAPI  IG_gctrl_item_by_index_get(
        UINT nIndex,
        LPCHAR CtrlID,
        DWORD dwIDSize,
        LPAT_MODE lpnValType,
        LPVOID lpValue,
        DWORD dwValSize,
        LPDWORD lpdwValSize,
        LPCHAR lpTextInfo,
        DWORD dwTextBufSize,
        LPDWORD lpdwTextInfoSize


Name Type Description
nIndex UINT IN: Index of global control parameter in the array.
CtrlID LPCHAR OUT: The name of global control parameter.
dwIDSize DWORD IN: Size of CtrlID in bytes.
lpnValType LPAT_MODE OUT: The type of global control parameter value.
lpValue LPVOID OUT: Buffer where to copy control parameter value.
dwValSize DWORD IN: Size of lpValue buffer in bytes.
lpdwValSize LPDWORD OUT: Actual size of parameter value in bytes.
lpTextInfo LPCHAR OUT: Buffer where to copy text description of global control parameter.
dwTextBufSize DWORD IN: Size of lpTextInfo buffer in bytes.
lpdwTextInfoSize LPDWORD OUT: Actual size of the text description of parameter.

Return Value:

TRUE if global parameter with given name is found; FALSE if it does not exist.

Supported Raster Image Formats:

This function does not process image pixels.


See also the section Working with Global Control Parameters.

Is this page helpful?
Yes No
Thanks for your feedback.