API Tree.StepNamedIndex: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	StepNamedIndex
Updates the object to point to the Nth next (younger) sibling matching the name
- HANDLE	Object
The object to update with the next found sibling
- STRING	TargetName
The name of the sibling to find
- LONG	Index
The index to find, 0 for the first including this
- NONE	Return

Detailed description

Examples

Calling in a calculation

Add to a calculation icon:

::Tree.StepNamedIndex(return_object, "targetname", index)

@@ Line 1: / Line 1: @@
-wiki page name
+{| class="mtx-class-macrotable wikitable"
-==TreeStepNamedIndex==
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''StepNamedIndex'''
+|-
+| colspan="2" | Updates the object to point to the Nth next (younger) sibling matching the name&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
+|-
+| colspan="2" | The object to update with the next found sibling&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | TargetName
+|-
+| colspan="2" | The name of the sibling to find&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Index
+|-
+| colspan="2" | The index to find, 0 for the first including this&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''
+|}
-Updates the object to point to the Nth next (younger) sibling matching the name
-----
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Object''
-:''This parameter is returned back to the caller''
-:The object to update with the next found sibling
-''[[Variable types|STRING]] TargetName''
-:The name of the sibling to find
-''[[Variable types|LONG]] Index''
-:The index to find, 0 for the first including this
-===Return value===
+==Examples==
-''This call does not return a value''
+===Calling in a calculation===
+* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepNamedIndex(return_object, "targetname", index)</pre>
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation:====
-* Add to a calculation icon: ::Tree.StepNamedIndex(return_object, "targetname", index)

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation