Difference between revisions of "API Scope.GetOutputBlock"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
(XML import of updated API docs) |
||
| Line 1: | Line 1: | ||
| + | |||
| + | |||
<sidebar>API contents</sidebar> | <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 41: | Line 43: | ||
* 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>'' |
Revision as of 09:58, 17 June 2013
<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
