PlusWnd::LstView_GetCheckedState

The PlusWnd::LstView_GetCheckedState function returns the checked state of an item in a ListViewControl.

Syntax

[boolean] LstView_GetCheckedState(
    [string] ControlId,
    [number] ItemIdx
);

Parameters

ControlId

[string] Unique identifier of the control.

ItemIdx

[number] Index of the item which check state is to be retrieved.

Return Value

A boolean value. The return is true if the item is checked and false if it's unchecked.

This function typically fails for the following reason:

• The PlusWnd object refers to a window that has been destroyed.

Remarks

This function will only work if the List View control is in Report View mode with the "HasCheckboxes" attribute set to true.

Function Information

See Also

PlusWnd Object, LstView_SetCheckedState.