Jump to content

API File.Buffer.Create: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
JonnyW (talk | contribs)
XML import of updated API docs
Line 1: Line 1:
<sidebar>API contents</sidebar>
<sidebar>API contents</sidebar>
Creates the new file as a circular buffer
Creates the new file as a circular buffer
Line 42: Line 44:
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Create("filename", bytes, false, true)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Create("filename", bytes, false, true)</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> Creates the new file as a circular buffer

Class hierarchy

File

Buffer
Create

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)

No additional examples