Difference between revisions of "API Scope.AddCustom"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import of API auto-gen)
Line 25: Line 25:
 
====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: result = ::Scope.AddCustom(streamh, channelix, false)
+
* Add to a calculation icon: <pre class="brush:[C]">result = ::Scope.AddCustom(streamh, channelix, false)</pre>

Revision as of 15:35, 10 May 2013

<sidebar>API contents</sidebar> Adds an input to the stream from a custom injection


Parameters

HANDLE StreamH

A handle to a previously created datascope stream

ULONG ChannelIx

An index from 0-32 of a custom analog value owned by the group

BOOL Subtract

True to subtract from the current stream, else add to the current value
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.AddCustom(streamh, channelix, false)