API Tree.GetSubValue: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetSubValue
Gets the value of a named sub-item of the given object, if available
- HANDLE	Object
The object to get a sub-items value from
- STRING	SubName
The name of the sub-item in Object
- STRING	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type STRING

Add to a calculation icon:

result = ::Tree.GetSubValue(object, "subname")

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the value of a named sub-item of the given object, if available
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetSubValue'''
+|-
+| colspan="2" | Gets the value of a named sub-item of the given object, if available&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
+|-
+| colspan="2" | The object to get a sub-items value from&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | SubName
+|-
+| colspan="2" | The name of the sub-item in Object&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''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Object''
-:The object to get a sub-items value from
-''[[Variable types|STRING]] SubName''
-:The name of the sub-item in Object
-===Return value===
-[[Variable types|STRING]]
-Returns the value of a named sub-item of the given object, if available
+==Examples==
+===Calling in a calculation===
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type STRING
-* Add to a calculation icon: <pre class="brush:[C]">result = ::Tree.GetSubValue(object, "subname")</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Tree.GetSubValue(object, "subname")</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation