Jump to content

API Scope.AddStream: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import of API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
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===
: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
Line 10: Line 16:
:The cosmetic name to display for the stream
:The cosmetic name to display for the stream


===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.AddStream(grouph, "name")</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddStream(grouph, "name")</pre>

Revision as of 16:51, 11 May 2013

<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")