GetCtrlVal
int GetCtrlVal (int panelHandle, int controlID, void *value);
Purpose
Obtains the current value of a control.
When the control ID is for a list box or ring control, GetCtrlVal returns the value of the currently selected list item. To obtain the index of the selected list item, use GetCtrlIndex.
 |
Note This function is not valid for graph and strip chart controls. |
Parameters
Input |
Name |
Type |
Description |
panelHandle |
integer |
Specifier for a particular panel that is currently in memory. You obtain this
handle from LoadPanel, NewPanel, or DuplicatePanel. |
controlID |
integer |
The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by NewCtrl or DuplicateCtrl. |
Output |
Name |
Type |
Description |
value |
void * |
The control value. The data type of value must match the data type of the control. |
Return Value
Name |
Type |
Description |
status |
integer |
Return value indicating whether the function was successful. A negative number indicates that an error occurred.
Code |
Error Message String |
xx |
Success |
|