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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import API auto-gen)
Line 1: Line 1:
 
wiki page name
 
wiki page name
==File.BufferCreate==
+
Creates the new file as a circular buffer
  
Creates the new file as a circular buffer
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 30: Line 28:
  
 
===Examples===
 
===Examples===
====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.Create("filename", bytes, false, true)
 
* Add to a calculation icon: result = ::File.Buffer.Create("filename", bytes, false, true)

Revision as of 15:34, 10 May 2013

wiki page name Creates the new file as a circular buffer


Parameters

STRING Filename

The name of a new file to create

ULONG Bytes

The number of bytes to fix the buffer to
The default value for this parameter is: 0x10000

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.Create("filename", bytes, false, true)