Difference between revisions of "API File.Buffer.Open"

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>
 
Opens the existing file as a circular buffer
 
Opens the existing file as a circular buffer
Line 38: Line 40:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Open("filename", true, false)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Open("filename", true, false)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Opens the existing file as a circular buffer

Class hierarchy

File

Buffer
Open

Parameters

STRING Filename

The name of an existing file to open

BOOL Write

Set to enable write access
The default value for this parameter is: 0

BOOL Monitor

Set to enable monitoring of the file
The default value for this parameter is: 0


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 = ::File.Buffer.Open("filename", true, false)

No additional examples