API Component.Property.GetListIndex

	GetListIndex
Gets a single lists index value from a property by line number
- HANDLE	Handle
The component handle to get the property of
- STRING	Property
The textual name of the property
- ULONG	LineIx
The lists line (first is zero) to read the index of
- STRING	Return

Detailed description

Given a Property which is a list type, this gets the index (3-character) part of the line corresponding to LineIx, with zero being the first line. This index can then be used in GetListItem and related calls.

The lines of the property are stored in its filter - see GetFilter.

No checks are performed to establish the property is of the correct type.

Examples

Calling in a calculation

• Declare a variable 'result' of type STRING
• Add to a calculation icon:

  result = ::Component.Property.GetListIndex(handle, "property", lineix)

No additional examples