Jump to content

API Connection.SetAn: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import API changes
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
Line 10: 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




==Return value==
==Return value==
[[Variable types|BOOL]]
[[Variable Types|BOOL]]


Returns true if the operation is a success, else false
Returns true if the operation is a success, else false

Revision as of 11:08, 10 June 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

Returns true if the operation is a success, else false


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