Difference between revisions of "API Tree.StepSubName"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
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===
 +
:Tree
 +
::StepSubName
 +
</div>
 +
__TOC__
  
===Parameters===
+
==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 11: Line 17:
 
:The name to find the item of
 
:The name to find the item of
  
===Return value===
+
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::Tree.StepSubName(return_object, "subname")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Tree.StepSubName(return_object, "subname")</pre>

Revision as of 21:13, 11 May 2013

<sidebar>API contents</sidebar> Updates the object to point to the named attribute, if any

Class hierarchy

Tree
StepSubName

Parameters

HANDLE Object

This parameter is returned back to the caller
The object containing sub-items to step to the first named item of

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:
    ::Tree.StepSubName(return_object, "subname")