Difference between revisions of "API Scope.AddBuffer"
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> | ||
Adds a fixed-view stream to the given group suitable for inputs and operations | Adds a fixed-view stream to the given group suitable for inputs and operations | ||
| Line 12: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''GroupH'' |
:A handle to a previously created datascope group | :A handle to a previously created datascope group | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Name'' |
:The cosmetic name to display for the stream | :The cosmetic name to display for the stream | ||
| − | [[Variable | + | [[Variable Types|FLOAT]] ''ClkStep'' |
:Clock increment per-sample of the buffer | :Clock increment per-sample of the buffer | ||
| − | [[Variable | + | [[Variable Types|UINT]] ''Samples'' |
:Number of samples to store in the buffer | :Number of samples to store in the buffer | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] |
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 11:09, 10 June 2013
<sidebar>API contents</sidebar> Adds a fixed-view stream to the given group suitable for inputs and operations
Contents
Parameters
HANDLE GroupH
- A handle to a previously created datascope group
STRING Name
- The cosmetic name to display for the stream
FLOAT ClkStep
- Clock increment per-sample of the buffer
UINT Samples
- Number of samples to store in the buffer
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Scope.AddBuffer(grouph, "name", clkstep, samples)
No additional information
