Jump to content

API Scope.AddStream: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import of API auto-gen
JonnyW (talk | contribs)
XML import
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
<sidebar>API Contents</sidebar>
Adds a stream to the given group suitable for inputs and operations
Adds a stream to the given group suitable for inputs and operations


<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Scope|Scope]]
:[[API Scope|AddStream]]
</div>
__TOC__


===Parameters===
==Parameters==
''[[Variable types|HANDLE]] GroupH''
[[Variable Types|HANDLE]] ''GroupH''
:A handle to a previously created datascope group
:A handle to a previously created datascope group


''[[Variable types|STRING]] Name''
[[Variable Types|STRING]] ''Name''
:The cosmetic name to display for the stream
:The cosmetic name to display for the stream


===Return value===
[[Variable types|HANDLE]]


No additional information
==Return value==
[[Variable Types|HANDLE]]


===Detailed description===
''<span style="color:red;">No additional information</span>''
''No additional information''


===Examples===
 
====Calling in a calculation====
==Detailed description==
''<span style="color:red;">No additional information</span>''
 
 
==Examples==
===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.AddStream(grouph, "name")</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddStream(grouph, "name")</pre>
 
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Adds a stream to the given group suitable for inputs and operations

Class hierarchy

Scope

AddStream

Parameters

HANDLE GroupH

A handle to a previously created datascope group

STRING Name

The cosmetic name to display for the stream


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.AddStream(grouph, "name")

No additional examples