Difference between revisions of "API Scope.AddCustom"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML import) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Adds an input to the stream from a custom injection | Adds an input to the stream from a custom injection | ||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''StreamH'' |
:A handle to a previously created datascope stream | :A handle to a previously created datascope stream | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''ChannelIx'' |
:An index from 0-31 of a custom analog value owned by the group | :An index from 0-31 of a custom analog value owned by the group | ||
| − | [[Variable | + | [[Variable Types|BOOL]] ''Subtract'' |
: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''' | ||
| Line 22: | Line 22: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|BOOL]] |
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
| Line 36: | Line 36: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddCustom(streamh, channelix, false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddCustom(streamh, channelix, false)</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<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 examples
