API Connection.GetAn: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetAn
Gets an analog value from its channel index
- 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
- FLOAT	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type FLOAT

Add to a calculation icon:

result = ::Connection.GetAn(channelix, true)

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets an analog value from its channel index
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetAn'''
+|-
+| colspan="2" | Gets an analog value from its channel index&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | ChannelIx
+|-
+| colspan="2" | The zero-based index of the analog channel&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | BitMult
+|-
+| colspan="2" | Set to read the analog value as a full-width reading for the selected device&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Connection|Connection]]
-:[[API Connection|GetAn]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|UINT]] ''ChannelIx''
-:The zero-based index of the analog channel
-[[Variable Types|BOOL]] ''BitMult''
-:Set to read the analog value as a full-width reading for the selected device
-==Return value==
-[[Variable Types|FLOAT]]
-''<span style="color:red;">No additional information</span>''
+==Detailed description==
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 31: / Line 30: @@
 * Declare a variable 'result' of type FLOAT
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetAn(channelix, true)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation