Difference between revisions of "API Scope.SetCustom"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(11 intermediate revisions by 2 users 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
  
 +
<div style="width:25%; float:right" class="toc">
 +
====Class hierarchy====
 +
[[API Scope|Scope]]
 +
:[[API Scope|SetCustom]]
 +
</div>
 +
__TOC__
  
===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-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
  
===Return value===
+
 
 +
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
 
''No additional information''
 
  
===Examples===
+
==Detailed description==
====Calling in a calculation====
+
''<span style="color:red;">No additional information</span>''
* Add to a calculation icon: ::Scope.SetCustom(grouph, channelix, value)
+
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 +
* 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

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