Jump to content

API Scope.AddCustom: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import of updated API docs
JonnyW (talk | contribs)
XML import of API documentation
Line 1: Line 1:




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



Revision as of 14:27, 9 August 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-31 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

Returns true if the operation is a success, else false


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 examples