wcGetItemData() Function

Reads the integer value associated with the list item identified by the ItemIndex parameter.

Category

windows control

Syntax

[ErrorNumber=]wcGetItemData("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

Actual name of a real or integer tagname. The wcGetItemData() function places the numeric value corresponding to the item 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 retrieves the numeric value associated with the fifth item in a list box and returns it to the ItemValue Integer tagname when an action script runs:

wcGetItemData("ListBox_1", 5, ItemValue);

If the fifth item in the list is assigned the integer value 4500, the ItemValue tagname contains 4500.

See Also

wcSetItemData()