Difference between revisions of "API Scope.SetBuffer"

From Flowcode Help
Jump to navigationJump to search
(XML import of latest API)
 
(XML import)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
<sidebar>API Contents</sidebar>
 
 
<sidebar>API contents</sidebar>
 
 
Sets the contents of a snapshot stream
 
Sets the contents of a snapshot stream
  
Line 12: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''StreamH''
+
[[Variable Types|HANDLE]] ''StreamH''
 
:A handle to a previously created datascope buffer
 
:A handle to a previously created datascope buffer
  
[[Variable types|ULONG]] ''ElemBase''
+
[[Variable Types|ULONG]] ''ElemBase''
 
:The index to start writing the data to in the buffer
 
:The index to start writing the data to in the buffer
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
  
[[Variable types|ULONG]] ''ElemStep''
+
[[Variable Types|ULONG]] ''ElemStep''
 
:The number of elements to tep after each write
 
:The number of elements to tep after each write
 
:''The default value for this parameter is: '''''1'''
 
:''The default value for this parameter is: '''''1'''
  
[[Variable types|ARRAY]] ''Values''
+
[[Variable Types|ARRAY]] ''Values''
 
:The buffer values to write, typically 0 to 1 floats
 
:The buffer values to write, typically 0 to 1 floats
  
[[Variable types|ULONG]] ''Elements''
+
[[Variable Types|ULONG]] ''Elements''
 
:The max number of elements to write from Values
 
:The max number of elements to write from Values
 
:''The default value for this parameter is: '''''-1'''
 
:''The default value for this parameter is: '''''-1'''
Line 43: Line 41:
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Scope.SetBuffer(streamh, elembase, elemstep, _arrayvalues, elements)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Scope.SetBuffer(streamh, elembase, elemstep, _arrayvalues, elements)</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 the contents of a snapshot stream

Class hierarchy

Scope

SetBuffer

Parameters

HANDLE StreamH

A handle to a previously created datascope buffer

ULONG ElemBase

The index to start writing the data to in the buffer
The default value for this parameter is: 0

ULONG ElemStep

The number of elements to tep after each write
The default value for this parameter is: 1

ARRAY Values

The buffer values to write, typically 0 to 1 floats

ULONG Elements

The max number of elements to write from Values
The default value for this parameter is: -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.SetBuffer(streamh, elembase, elemstep, _arrayvalues, elements)

No additional examples