Difference between revisions of "API Connection.SetAn"

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;"
−
Sets an analog value from its index, range 0->1
+
|-
−
 
+
| 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;" | '''SetAn'''
−
====Class hierarchy====
+
|-
−
[[API Connection|Connection]]
+
| colspan="2" | Sets an analog value from its index, range 0->1&nbsp;
−
:[[API Connection|SetAn]]
+
|-
−
</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-f32-icon.png]] - FLOAT
−
[[Variable Types|FLOAT]] ''Value''
+
| width="90%" | Value
−
:Value to set, 0 to 1 if BitDivide is false
+
|-
−
 
+
| colspan="2" | Value to set, 0 to 1 if BitDivide is false&nbsp;
−
[[Variable Types|BOOL]] ''BitDivide''
+
|-
−
:Set to write the analog value as a full-width reading for the selected device
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
−
 
+
| width="90%" | BitDivide
−
 
+
|-
−
==Return value==
+
| colspan="2" | Set to write the analog value as a full-width reading for the selected device&nbsp;
−
[[Variable Types|BOOL]]
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
−
Returns true if the operation is a success, else false
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  

Revision as of 11:41, 16 January 2023

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


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon: 
    result = ::Connection.SetAn(channelix, value, false)

No additional examples

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Connection.SetAn&oldid=29953"