Difference between revisions of "API Connection.GetAn"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets an analog value from its channel index
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAn'''
====Class hierarchy====
+
|-
[[API Connection|Connection]]
+
| colspan="2" | Gets an analog value from its channel index&nbsp;
:[[API Connection|GetAn]]
+
|-
</div>
+
|-
__TOC__
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
+
| width="90%" | ChannelIx
==Parameters==
+
|-
[[Variable Types|UINT]] ''ChannelIx''
+
| colspan="2" | The zero-based index of the analog channel&nbsp;
:The zero-based index of the analog channel
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
[[Variable Types|BOOL]] ''BitMult''
+
| width="90%" | BitMult
:Set to read the analog value as a full-width reading for the selected device
+
|-
 
+
| colspan="2" | Set to read the analog value as a full-width reading for the selected device&nbsp;
 
+
|-
==Return value==
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
[[Variable Types|FLOAT]]
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
+
|}
''<span style="color:red;">No additional information</span>''
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png GetAn
Gets an analog value from its channel index 
Fc9-u16-icon.png - UINT ChannelIx
The zero-based index of the analog channel 
Fc9-bool-icon.png - BOOL BitMult
Set to read the analog value as a full-width reading for the selected device 
Fc9-f32-icon.png - FLOAT Return


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