Difference between revisions of "API Scope.SetCustom"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
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===
 +
: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
Line 13: Line 19:
 
: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''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::Scope.SetCustom(grouph, channelix, value)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Scope.SetCustom(grouph, channelix, value)</pre>

Revision as of 16:57, 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)