wcGetItem() Function

Returns a string containing the contents of the item corresponding to the ItemIndex in the list box or combo box.

Category

windows control

Syntax

[ErrorNumber=]wcGetItem("ControlName", ItemIndex, Tagname);

Parameters

ControlName

The name of the windows control object. For example, ListBox_1. Actual string or message tagname.

ItemIndex

A number corresponding to the position of the item. Any number or Integer tagname.

Tagname

Message tagname. The wcGetItem function will place the data corresponding to the item index into this tagname upon return from the function.

Remarks

For a list of returned error numbers, see Understand windows controls error messages.

Applies To

List boxes and combo boxes.

Example(s)

The following statement returns the string value of the tenth item in a combo box to the ListSelection message tag when an action script runs:

wcGetItem("Combobox_1", 10, ListSelection);

If item ten in the list is "Vanilla," then the ListSelection tag contains the string "Vanilla".