API Scope.AddAnalog: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
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=== | |||
:Scope | |||
::AddAnalog | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] StreamH'' | ''[[Variable types|HANDLE]] StreamH'' | ||
:A handle to a previously created datascope stream | :A handle to a previously created datascope stream | ||
| Line 14: | Line 20: | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
==Return value== | |||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
No additional information | No additional information | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddAnalog(streamh, channelix, false)</pre> | ||
Revision as of 16:53, 11 May 2013
<sidebar>API contents</sidebar> Adds an input to the stream from an analog channel
Class hierarchy
- Scope
- AddAnalog
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
No additional information
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)