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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import of API auto-gen)
Line 26: Line 26:
 
====Calling in a calculation====
 
====Calling in a calculation====
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: result = ::File.Buffer.Open("filename", true, false)
+
* Add to a calculation icon: <pre class="brush:[C]">result = ::File.Buffer.Open("filename", true, false)</pre>

Revision as of 15:35, 10 May 2013

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


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)