Difference between revisions of "API Scope.SetCustom"

From Flowcode Help
Jump to navigationJump to search
(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 Scope|Scope]]
+
====Class hierarchy====
 +
[[API Scope|Scope]]
 
:[[API Scope|SetCustom]]
 
:[[API Scope|SetCustom]]
 
</div>
 
</div>
Line 9: 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-32 of a custom analog value owned by the group
 
:An index from 0-32 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 22: Line 23:
  
 
==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 information</span>''

Revision as of 22:10, 11 May 2013

<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-32 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 information