ImageGear provides a set of API functions that allow you to add new global control parameters to your ImageGear application, set new values for existing global control parameters, and retrieve information about these parameters.

To add a new global parameter as well as to set new values for existing parameters, use the function IG_gctrl_item_set:

IG_gctrl_item_set(
        LPCHAR ControlID, 
        AT_MODE nValueType, 
        LPVOID lpValue, 
        DWORD dwValueSize, 
        LPCHAR lpTextInfo
);

This function will search for the global parameter specified by the ControlIDname (syntax: "<GRPNAME>.<Param name>"), and if it is found will set a new value for it. If it is not found, the function will add this new parameter to the global control parameters list. Through the lpTextInfo argument, you can also set the text description of the specified global parameter.

To retrieve information about the global control parameter, use the functions IG_gctrl_item_get and IG_gctrl_item_by_index_get:

IG_gctrl_item_get(
        LPCHAR CtrlID, 
        LPAT_MODE lpnValType, 
        LPVOID lpValue, 
        DWORD dwValSize, 
        LPDWORD lpdwValSize, 
        LPCHAR lpTextInfo, 
        DWORD dwTextBufSize, 
        LPDWORD lpdwTextInfoSize
);

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 
);

The first function returns the value and the text description of the global control parameter specified by name. The second function returns information about the control parameter specified by its index in the global parameters list. Both functions return FALSE if the specified global parameter is not found.

If you want to know the general amount of global control parameters currently existing in the global parameters list, call the function IG_gctrl_item_count_get:

IG_gctrl_item_count_get();

If you need to know an index of the global control parameter in the parameters array, use this function IG_gctrl_item_id_get:

IG_gctrl_item_id_get (
        UINT nIndex, 
        LPCHAR lpCtrlID, 
        UINT nBufSize
);

Please also see the list of all ImageGear Global Control Parameters.

©2014. Accusoft Corporation. All Rights Reserved.