Difference between revisions of "API Scope.SetBuffer"
From Flowcode Help
Jump to navigationJump to search (XML import of latest API) |
(XML Import to change Variable types into Variable Types) |
||
| 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 | + | [[Variable Types|HANDLE]] ''StreamH'' |
:A handle to a previously created datascope buffer | :A handle to a previously created datascope buffer | ||
| − | [[Variable | + | [[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 | + | [[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 | + | [[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 | + | [[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''' | ||
Revision as of 11:09, 10 June 2013
<sidebar>API contents</sidebar> Sets the contents of a snapshot stream
Contents
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 information
