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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API |API ]]
+
===Class hierarchy===[[API File|File]]
:[[API File|File]]
+
:[[API File.Buffer|Buffer]]
::[[API File.Buffer|Buffer]]
+
::[[API File.Buffer|Open]]
:::Open
 
 
</div>
 
</div>
 
__TOC__
 
__TOC__

Revision as of 21:25, 11 May 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)