API Scope.AddAnalog: Difference between revisions
XML import API auto-gen |
XML import |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
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 | ||
<div style="width:25%; float:right" class="toc"> | |||
====Class hierarchy==== | |||
[[API Scope|Scope]] | |||
:[[API Scope|AddAnalog]] | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
[[Variable Types|HANDLE]] ''StreamH'' | |||
:A handle to a previously created datascope stream | :A handle to a previously created datascope stream | ||
[[Variable Types|ULONG]] ''ChannelIx'' | |||
:A zero based analog channel index | :A zero based analog channel index | ||
[[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''' | ||
==Return value== | |||
[[Variable Types|BOOL]] | |||
Returns true if the operation is a success, else false | |||
===Examples | |||
==Detailed description== | |||
''<span style="color:red;">No additional information</span>'' | |||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: result = ::Scope.AddAnalog(streamh, channelix, false) | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddAnalog(streamh, channelix, false)</pre> | ||
''<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