Difference between revisions of "API Scope.AddCustom"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import API changes) |
||
| Line 14: | Line 14: | ||
[[Variable types|ULONG]] ''ChannelIx'' | [[Variable types|ULONG]] ''ChannelIx'' | ||
| − | :An index from 0- | + | :An index from 0-31 of a custom analog value owned by the group |
[[Variable types|BOOL]] ''Subtract'' | [[Variable types|BOOL]] ''Subtract'' | ||
| 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 13:15, 14 May 2013
<sidebar>API contents</sidebar> Adds an input to the stream from a custom injection
Contents
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
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
