Difference between revisions of "API Scope.SetCustom"
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 one of 32 custom analog values for the group | Sets one of 32 custom analog values for the group | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy=== | + | ====Class hierarchy==== |
| − | + | [[API Scope|Scope]] | |
| − | : | + | :[[API Scope|SetCustom]] |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''GroupH'' | |
:The group handle that owns the custom channel | :The group handle that owns the custom channel | ||
| − | + | [[Variable Types|ULONG]] ''ChannelIx'' | |
| − | :An index from 0- | + | :An index from 0-31 of a custom analog value owned by the group |
| − | + | [[Variable Types|FLOAT]] ''Value'' | |
:A value to set the channel to, typically 0 to 1 | :A value to set the channel to, typically 0 to 1 | ||
| + | |||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Scope.SetCustom(grouph, channelix, value)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Scope.SetCustom(grouph, channelix, value)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets one of 32 custom analog values for the group
Contents
Parameters
HANDLE GroupH
- The group handle that owns the custom channel
ULONG ChannelIx
- An index from 0-31 of a custom analog value owned by the group
FLOAT Value
- A value to set the channel to, typically 0 to 1
Return value
This call does not return a value
Detailed description
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::Scope.SetCustom(grouph, channelix, value)
No additional examples
