IsListItemChecked
int IsListItemChecked (int panelHandle, int controlID, int itemIndex, int *checked);
Purpose
Returns a Boolean value indicating whether or not a specific list item is checked.
This function applies only to list boxes with the check mode attribute enabled.
Supported Controls
You can use IsListItemChecked 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. |
| itemIndex | int | Zero-based index into the list control. |
| Output | ||
| Name | Type | Description |
| checked | int | A Boolean value indicating whether the list item is checked. 0 = not checked 1 = checked |
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 IsListItemChecked function:
- userint\listbox.cws
Open example - userint\treesearch.cws
Open example