API Component.Property.GetListItem: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetListItem
Gets a single list entry from a property by named index
- HANDLE	Handle
The component handle to get the property of
- STRING	Property
The textual name of the property
- STRING	Index
The text or integer entry of the property
- STRING	Return

Detailed description

Gets the text part of a list property identified by its 3-digit Index'.

Note the Index is not the line of the list to extract, but the 3-digit identifier. If multiple lines have the same identifier this will extract the first found.

To find the index from the line, use GetListIndex.

Examples

Calling in a calculation

Declare a variable 'result' of type STRING

Add to a calculation icon:

result = ::Component.Property.GetListItem(handle, "property", "index")

@@ Line 1: / Line 1: @@
-wiki page name
+{| class="mtx-class-macrotable wikitable"
-==Component.PropertyGetListItem==
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetListItem'''
+|-
+| colspan="2" | Gets a single list entry from a property by named index&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Handle
+|-
+| colspan="2" | The component handle to get the property of&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Property
+|-
+| colspan="2" | The textual name of the property&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Index
+|-
+| colspan="2" | The text or integer entry of the property&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-Gets a single list entry from a property by named index
-----
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Handle''
+Gets the text part of a list property identified by its 3-digit ''Index'.
-:The component handle to get the property of
-''[[Variable types|STRING]] Property''
-:The textual name of the property
-''[[Variable types|STRING]] Index''
+Note the ''Index'' is not the line of the list to extract, but the 3-digit identifier. If multiple lines have the same identifier this will extract the first found.
-:The text or integer entry of the property
-===Return value===
-[[Variable types|STRING]]
-Returns the single list entry from a property by named index
+To find the index from the line, use [[API Component.Property.GetListIndex|GetListIndex]].
-===Detailed description===
-''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation:====
+===Calling in a calculation===
 * Declare a variable 'result' of type STRING
-* Add to a calculation icon: result = ::Component.Property.GetListItem(handle, "property", "index")
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation