Difference between revisions of "API Scope.GetOutputBlock"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML import) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets a block of the output stream with each input sample operated on, returns number of samples read | Gets a block of the output stream with each input sample operated on, returns number of samples read | ||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''StreamH'' |
:The stream that is to be read | :The stream that is to be read | ||
| − | [[Variable | + | [[Variable Types|LONG]] ''TimeUS'' |
:The time offset to extract the history from, in microseconds | :The time offset to extract the history from, in microseconds | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''TimeStep'' |
:The step in microseconds between each sample extracted | :The step in microseconds between each sample extracted | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''Samples'' |
:The number of samples to extract - this will expand the array | :The number of samples to extract - this will expand the array | ||
| − | [[Variable | + | [[Variable Types|FLOAT[]]] ''Buffer'' |
:The buffer to read the sample data into | :The buffer to read the sample data into | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|ULONG]] |
Returns the block of the output stream with each input sample operated on, returns number of samples read | Returns the block of the output stream with each input sample operated on, returns number of samples read | ||
| Line 41: | Line 41: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.GetOutputBlock(streamh, timeus, timestep, samples, _arraybuffer)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.GetOutputBlock(streamh, timeus, timestep, samples, _arraybuffer)</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets a block of the output stream with each input sample operated on, returns number of samples read
Contents
Parameters
HANDLE StreamH
- The stream that is to be read
LONG TimeUS
- The time offset to extract the history from, in microseconds
ULONG TimeStep
- The step in microseconds between each sample extracted
ULONG Samples
- The number of samples to extract - this will expand the array
FLOAT[] Buffer
- The buffer to read the sample data into
Return value
Returns the block of the output stream with each input sample operated on, returns number of samples read
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::Scope.GetOutputBlock(streamh, timeus, timestep, samples, _arraybuffer)
No additional examples
