Jump to content

API Scope.SetCustom: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import API changes
JonnyW (talk | contribs)
XML import
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
<sidebar>API Contents</sidebar>
Sets one of 32 custom analog values for the group
Sets one of 32 custom analog values for the group


Line 10: Line 10:


==Parameters==
==Parameters==
[[Variable types|HANDLE]] ''GroupH''
[[Variable Types|HANDLE]] ''GroupH''
:The group handle that owns the custom channel
:The group handle that owns the custom channel


[[Variable types|ULONG]] ''ChannelIx''
[[Variable Types|ULONG]] ''ChannelIx''
:An index from 0-31 of a custom analog value owned by the group
:An index from 0-31 of a custom analog value owned by the group


[[Variable types|FLOAT]] ''Value''
[[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


Line 32: Line 32:
* 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 information</span>''
''<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

Class hierarchy

Scope

SetCustom

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