ListBox.GetChecked

OverviewExamples

table ListBox.GetChecked (

string ObjectName,

number CheckState )

Description

Returns a table containing the indexes (line numbers) of the matching checked items in a listbox object.

Parameters

ObjectName

(string) The name of the listbox object.

CheckState

(number) The checkbox state to search for. Only items with this checkbox state will be found. Choose from:

CONSTANT	VALUE	DESCRIPTION
BST_UNCHECKED	0	Unchecked items.
BST_CHECKED	1	Checked items.
BST_INDETERMINATE	2	"Indeterminate" state items.

Returns

(table) A numerically indexed table containing the item indexes that match the selected CheckState. If no items match or an error occurs, nil is returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.