PlusWnd::LstBox_GetCurSel

The PlusWnd::LstBox_GetCurSel function returns the current selection in a ListBoxControl.

Syntax

[number] LstBox_GetCurSel(
    [string] ControlId
);

Parameters

ControlId

[string] Unique identifier of the control.

Return Value

A number specifying the index of the item currently selected in the combo's list. If no item is selected, the return value is -1.

This function typically fails for the following reason:

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

Remarks

If "MultipleSel" is set to true in the List Box's attributes, this function returns the index of the item that has the focus rectangle.

Function Information

See Also

PlusWnd Object, LstBox_SetCurSel.