Difference between revisions of "API Connection.SetAn"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
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"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API | | + | ====Class hierarchy==== |
| − | :[[API Connection| | + | [[API Connection|Connection]] |
| − | + | :[[API Connection|SetAn]] | |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|UINT]] ''ChannelIx'' | |
:The zero-based index of the analog channel | :The zero-based index of the analog channel | ||
| − | + | [[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'' | |
: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 | + | [[Variable Types|BOOL]] |
| + | |||
| + | Returns true if the operation is a success, else false | ||
| − | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 31: | 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 examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets an analog value from its index, range 0->1
Contents
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
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 examples
