Jump to content

API Scope.AddCustom: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
Admin (talk | contribs)
XML import
Line 23: Line 23:
==Return value==
==Return value==
[[Variable types|BOOL]]
[[Variable types|BOOL]]
Returns true if the operation is a success, else false
Returns true if the operation is a success, else false



Revision as of 21:53, 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 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 information