GetCtrlIndex
int GetCtrlIndex (int panelHandle, int controlID, int *itemIndex);
Purpose
Returns the zero-based index of the currently selected item in the specified control.
To obtain the value of the currently selected item, call GetCtrlVal.
Supported Controls
You can use GetCtrlIndex with the following controls:
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | 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 functions such as NewCtrl and DuplicateCtrl. |
| Output | ||
| Name | Type | Description |
| itemIndex | int | The zero-based current index of the currently selected item. –1 if the list control has no items. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Examples
Refer to the following examples that use the GetCtrlIndex function:
- userint\graphlegend.cws
Open example - userint\imagedit.cws
Open example