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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 21: Line 21:
 
:Set to enable monitoring of the file
 
:Set to enable monitoring of the file
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
 +
  
 
==Return value==
 
==Return value==
Line 26: Line 27:
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
 
  
  

Revision as of 01:56, 12 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)

No additional information