API Connection.GetAn: Difference between revisions
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|GetAn]] | :[[API Connection|GetAn]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|UINT]] ''ChannelIx'' | |||
:The zero-based index of the analog channel | :The zero-based index of the analog channel | ||
[[Variable types|BOOL]] ''BitMult'' | |||
: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 | ||
| Line 18: | Line 19: | ||
[[Variable types|FLOAT]] | [[Variable types|FLOAT]] | ||
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 27: | Line 31: | ||
* Declare a variable 'result' of type FLOAT | * Declare a variable 'result' of type FLOAT | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetAn(channelix, true)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetAn(channelix, true)</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:10, 11 May 2013
<sidebar>API contents</sidebar> Gets an analog value from its channel index
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)
No additional information