API Connection.SetAn: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Sets an analog value from its index, range 0->1 | Sets an analog value from its index, range 0->1 | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Connection | |||
::SetAn | |||
</div> | |||
__TOC__ | |||
==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 | ||
| Line 13: | Line 19: | ||
: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== | |||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
No additional information | No additional information | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetAn(channelix, value, false)</pre> | ||
Revision as of 17:04, 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
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)