Difference between revisions of "API Scope.AddGroup"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Adds a group to the scope to which streams may be added
 
Adds a group to the scope to which streams may be added
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Scope
 +
::AddGroup
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|STRING]] Name''
 
''[[Variable types|STRING]] Name''
 
:The cosmetic name to display for the group
 
:The cosmetic name to display for the group
  
===Return value===
+
==Return value==
 
[[Variable types|HANDLE]]
 
[[Variable types|HANDLE]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[C]">result = ::Scope.AddGroup("name")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddGroup("name")</pre>

Revision as of 16:51, 11 May 2013

<sidebar>API contents</sidebar> Adds a group to the scope to which streams may be added

Class hierarchy

Scope
AddGroup

Parameters

STRING Name

The cosmetic name to display for the group

Return value

HANDLE

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Scope.AddGroup("name")