PlusWnd::LstBox_AddItem

The PlusWnd::LstBox_AddItem function adds an item in a ListBoxControl.

Syntax

[number] LstBox_AddItem(
    [string] ControlId,
    [string] Label,
    [number, optional] ItemData
);

Parameters

ControlId

[string] Unique identifier of the control.

Label

[string] Text label of the new item.

ItemData

[number, optional] If used, a number associated with the new item. It can be anything the developer wishes it to be.

Return Value

If the new item is added successfully, the return value is the index of the new item in the list. If not, 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

None.

Function Information

See Also

PlusWnd Object.