Difference between revisions of "API Connection.SetAn"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API Connection|Connection]]
+
====Class hierarchy====
 +
[[API Connection|Connection]]
 
:[[API Connection|SetAn]]
 
:[[API Connection|SetAn]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==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|FLOAT]] Value''
+
[[Variable types|FLOAT]] ''Value''
 
:Value to set, 0 to 1 if BitDivide is false
 
:Value to set, 0 to 1 if BitDivide is false
  
''[[Variable types|BOOL]] BitDivide''
+
[[Variable types|BOOL]] ''BitDivide''
 
:Set to write the analog value as a full-width reading for the selected device
 
:Set to write the analog value as a full-width reading for the selected device
  
Line 21: Line 22:
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
  
No additional information
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 30: Line 34:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetAn(channelix, value, false)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetAn(channelix, value, false)</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:10, 11 May 2013

<sidebar>API contents</sidebar> Sets an analog value from its index, range 0->1

Class hierarchy

Connection

SetAn

Parameters

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

Return value

BOOL

No additional information


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 information