API Tree.StepNamedIndex: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Updates the object to point to the Nth next (younger) sibling matching the name | Updates the object to point to the Nth next (younger) sibling matching the name | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Tree | |||
::StepNamedIndex | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Object'' | ''[[Variable types|HANDLE]] Object'' | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| Line 14: | Line 20: | ||
:The index to find, 0 for the first including this | :The index to find, 0 for the first including this | ||
==Return value== | |||
''This call does not return a value'' | ''This call does not return a value'' | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepNamedIndex(return_object, "targetname", index)</pre> | ||
Revision as of 20:38, 11 May 2013
<sidebar>API contents</sidebar> Updates the object to point to the Nth next (younger) sibling matching the name
Class hierarchy
- Tree
- StepNamedIndex
Parameters
HANDLE Object
- This parameter is returned back to the caller
- 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
Return value
This call does not return a value
Detailed description
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::Tree.StepNamedIndex(return_object, "targetname", index)