Difference between revisions of "API Scope.AddOp"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Adds an operation to act on the inputs of the stream
 
Adds an operation to act on the inputs of the stream
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Scope
 +
::AddOp
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] StreamH''
 
''[[Variable types|HANDLE]] StreamH''
 
:A handle to a previously created datascope stream
 
:A handle to a previously created datascope stream
Line 37: Line 43:
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
  
===Return value===
+
==Return value==
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
  
 
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 BOOL
 
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: <pre class="brush:[C]">result = ::Scope.AddOp(streamh, ::Scope.Op_Bound, arg)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddOp(streamh, ::Scope.Op_Bound, arg)</pre>

Revision as of 16:56, 11 May 2013

<sidebar>API contents</sidebar> Adds an operation to act on the inputs of the stream

Class hierarchy

Scope
AddOp

Parameters

HANDLE StreamH

A handle to a previously created datascope stream

ULONG FuncOp

An operation to perform on the input

Typical values for this parameter:

FLOAT Arg

An optional argument that may be used by the FuncOp
The default value for this parameter is: 0

Return value

BOOL

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Scope.AddOp(streamh, ::Scope.Op_Bound, arg)