Difference between revisions of "API Connection.GetAn"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Gets an analog value from its channel index | Gets an analog value from its channel index | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Connection | ||
| + | ::GetAn | ||
| + | </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 10: | Line 16: | ||
:Set to read the analog value as a full-width reading for the selected device | :Set to read the analog value as a full-width reading for the selected device | ||
| − | + | ==Return value== | |
[[Variable types|FLOAT]] | [[Variable types|FLOAT]] | ||
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 FLOAT | * Declare a variable 'result' of type FLOAT | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetAn(channelix, true)</pre> |
Revision as of 17:03, 11 May 2013
<sidebar>API contents</sidebar> Gets an analog value from its channel index
Class hierarchy
- Connection
- GetAn
Contents
Parameters
UINT ChannelIx
- The zero-based index of the analog channel
BOOL BitMult
- Set to read 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 FLOAT
- Add to a calculation icon:
result = ::Connection.GetAn(channelix, true)
