API Scope.AddAnalog: Difference between revisions

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Adds an input to the stream from an analog channel

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

Returns true if the operation is a success, else false

No additional information

Add to a calculation icon:

result = ::Scope.AddAnalog(streamh, channelix, false)

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+<sidebar>API Contents</sidebar>
 Adds an input to the stream from an analog channel
 <div style="width:25%; float:right" class="toc">
-===Class hierarchy===
+====Class hierarchy====
-:Scope
+[[API Scope|Scope]]
-::AddAnalog
+:[[API Scope|AddAnalog]]
 </div>
 __TOC__
 ==Parameters==
-''[[Variable types|HANDLE]] StreamH''
+[[Variable Types|HANDLE]] ''StreamH''
 :A handle to a previously created datascope stream
-''[[Variable types|ULONG]] ChannelIx''
+[[Variable Types|ULONG]] ''ChannelIx''
 :A zero based analog channel index
-''[[Variable types|BOOL]] Subtract''
+[[Variable Types|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==
-[[Variable types|BOOL]]
+[[Variable Types|BOOL]]
+Returns true if the operation is a success, else false
-No additional information
 ==Detailed description==
-''No additional information''
+''<span style="color:red;">No additional information</span>''
 ==Examples==
@@ Line 32: / Line 35: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddAnalog(streamh, channelix, false)</pre>
+''<span style="color:red;">No additional examples</span>''