API Connection.SetAn: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetAn
Sets an analog value from its index, range 0->1
- UINT	ChannelIx
The zero-based index of the analog channel
- FLOAT	Value
Value to set, 0 to 1 if BitDivide is false
- BOOL	BitDivide
Set to write the analog value as a full-width reading for the selected device
- BOOL	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type BOOL

Add to a calculation icon:

result = ::Connection.SetAn(channelix, value, false)

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''SetAn'''
+|-
+| colspan="2" | Sets an analog value from its index, range 0->1&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-f32-icon.png]] - FLOAT
+| width="90%" | Value
+|-
+| colspan="2" | Value to set, 0 to 1 if BitDivide is false&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | BitDivide
+|-
+| colspan="2" | Set to write 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-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<sidebar>API Contents</sidebar>
+==Detailed description==
-Sets an analog value from its index, range 0->1
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Connection|Connection]]
-:[[API Connection|SetAn]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|UINT]] ''ChannelIx''
-:The zero-based index of the analog channel
-[[Variable Types|FLOAT]] ''Value''
-:Value to set, 0 to 1 if BitDivide is false
-[[Variable Types|BOOL]] ''BitDivide''
-:Set to write the analog value as a full-width reading for the selected device
-==Return value==
-[[Variable Types|BOOL]]
-Returns true if the operation is a success, else false
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 36: / Line 35: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetAn(channelix, value, false)</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