Difference between revisions of "API Connection.GetAn"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
 
Gets an analog value from its channel index
 
Gets an analog value from its channel index
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API Connection|Connection]]
 +
:[[API Connection|GetAn]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|UINT]] ChannelIx''
+
[[Variable Types|UINT]] ''ChannelIx''
 
:The zero-based index of the analog channel
 
:The zero-based index of the analog channel
  
''[[Variable types|BOOL]] BitMult''
+
[[Variable Types|BOOL]] ''BitMult''
 
:Set to read the analog value as a full-width reading for the selected device
 
:Set to read the analog value as a full-width reading for the selected device
  
===Return value===
 
[[Variable types|FLOAT]]
 
  
No additional information
+
==Return value==
 +
[[Variable Types|FLOAT]]
  
===Detailed description===
+
''<span style="color:red;">No additional information</span>''
''No additional information''
 
  
===Examples===
+
 
====Calling in a calculation====
+
==Detailed description==
 +
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 
* Declare a variable 'result' of type FLOAT
 
* Declare a variable 'result' of type FLOAT
* Add to a calculation icon: result = ::Connection.GetAn(channelix, true)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetAn(channelix, true)</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets an analog value from its channel index

Class hierarchy

Connection

GetAn

Parameters

UINT ChannelIx

The zero-based index of the analog channel

BOOL BitMult

Set to read the analog value as a full-width reading for the selected device


Return value

FLOAT

No additional information


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type FLOAT
  • Add to a calculation icon:
    result = ::Connection.GetAn(channelix, true)

No additional examples