API Tree.StepSubName: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	StepSubName
Updates the object to point to the named attribute, if any
- HANDLE	Object
The object containing sub-items to step to the first named item of
- STRING	SubName
The name to find the item of
- NONE	Return

Detailed description

Examples

Calling in a calculation

Add to a calculation icon:

::Tree.StepSubName(return_object, "subname")

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Updates the object to point to the named attribute, if any
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''StepSubName'''
+|-
+| colspan="2" | Updates the object to point to the named attribute, if any&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
+|-
+| colspan="2" | The object containing sub-items to step to the first named item of&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | SubName
+|-
+| colspan="2" | The name to find the item of&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===
-:Tree
-::StepSubName
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] Object''
-:''This parameter is returned back to the caller''
-:The object containing sub-items to step to the first named item of
-''[[Variable types|STRING]] SubName''
-:The name to find the item of
-==Return value==
-''This call does not return a value''
-==Detailed description==
-''No additional information''
 ==Examples==
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepSubName(return_object, "subname")</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation