Difference between revisions of "API Scope.AddCustom"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 19: Line 19:
 
:True to subtract from the current stream, else add to the current value
 
:True to subtract from the current stream, else add to the current value
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
 +
  
 
==Return value==
 
==Return value==
Line 24: Line 25:
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
 
  
  

Revision as of 01:54, 12 May 2013

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

Class hierarchy

Scope

AddCustom

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)

No additional information