Difference between revisions of "API Tree.StepSubName"

Latest revision as of 15:58, 16 January 2014

<sidebar>API Contents</sidebar> 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

This parameter is returned back to the caller

STRING SubName

The name to find the item of

This call does not return a value

No additional information

Add to a calculation icon:

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

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
-==TreeStepSubName==
+Updates the object to point to the named attribute, if any
-Updates the object to point to the named attribute, if any
+<div style="width:25%; float:right" class="toc">
-----
+====Class hierarchy====
+[[API Tree|Tree]]
+:[[API Tree|StepSubName]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] Object''
+[[Variable Types|HANDLE]] ''Object''
+:The object containing sub-items to step to the first named item of
 :''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''
+[[Variable Types|STRING]] ''SubName''
 :The name to find the item of
-===Return value===
+==Return value==
 ''This call does not return a value''
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation:====
+''<span style="color:red;">No additional information</span>''
-* Add to a calculation icon: ::Tree.StepSubName(return_object, "subname")
+==Examples==
+===Calling in a calculation===
+* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepSubName(return_object, "subname")</pre>
+''<span style="color:red;">No additional examples</span>''