Difference between revisions of "API Scope.AddCustom"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
(XML import of updated API docs) |
||
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 | ||
Line 36: | Line 38: | ||
* 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>'' |
Revision as of 09:58, 17 June 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 examples