API Scope.AddAnalog: Difference between revisions
XML import |
XML import |
||
| (4 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 an analog channel | Adds an input to the stream from an analog channel | ||
| 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'' | ||
:A zero based analog channel index | :A zero based analog channel index | ||
[[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 35: | Line 36: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddAnalog(streamh, channelix, false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddAnalog(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 an analog channel
Parameters
HANDLE StreamH
- A handle to a previously created datascope stream
ULONG ChannelIx
- A zero based analog channel index
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.AddAnalog(streamh, channelix, false)
No additional examples