Jump to content

API Scope.AddBuffer: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import of updated API docs
JonnyW (talk | contribs)
XML import of API documentation
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



Revision as of 14:27, 9 August 2013


<sidebar>API Contents</sidebar> Adds a fixed-view stream to the given group suitable for inputs and operations

Class hierarchy

Scope

AddBuffer

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

HANDLE

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 examples