ImageGear for C and C++ on Windows v19.0
IG_gctrl_item_set
| API Reference Guide > Core Component API Reference > Core Component Functions Reference > Global Control Parameter Functions > IG_gctrl_item_set |
This function sets the value to global control parameter.
 |
Please see Global Control Parameters for a list of all the corresponding types to use. |
|
Copy Code
|
|
|---|---|
AT_ERRCODE ACCUAPI IG_gctrl_item_set(
LPCHAR CtrlID,
AT_MODE nValueType,
LPVOID lpValue,
DWORD dwValueSize,
LPCHAR lpTextInfo
);
|
|
| Name | Type | Description |
|---|---|---|
| CtrlID | LPCHAR | IN: The name of global control parameter in form "<GRPNAME>.<Param name>". |
| nValueType | AT_MODE | IN: The type of global control parameter value. Constant of kind AM_TID_... |
| lpValue | LPVOID | IN: Pointer to global control parameter value data. |
| dwValueSize | DWORD | IN: Size of global control parameter value data (size of buffer lpValue) |
| lpTextInfo | LPCHAR | IN: Text description of global control parameter value. |
Return value is a code of last error or NULL if success.
This function does not process image pixels.
None
If parameter with given name ControlID does not exist, then it is added. If control parameter with given value exists and callback function for it is not NULL then callback is called exactly after value is changed by this function. If lpTextInfo is not NULL, then previous value of this field is changed to new value, but if NULL then it is not changed.
See also the section Working with Global Control Parameters.