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

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
−
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Creates the new file as a circular buffer
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Create'''
−
====Class hierarchy====
+
|-
−
[[API File|File]]
+
| colspan="2" | Creates the new file as a circular buffer&nbsp;
−
:[[API File.Buffer|Buffer]]
+
|-
−
::[[API File.Buffer|Create]]
+
|-
−
</div>
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
__TOC__
+
| width="90%" | Filename
−
 
+
|-
−
==Parameters==
+
| colspan="2" | The name of a new file to create&nbsp;
−
[[Variable Types|STRING]] ''Filename''
+
|-
−
:The name of a new file to create
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
−
 
+
| width="90%" | Bytes
−
[[Variable Types|ULONG]] ''Bytes''
+
|-
−
:The number of bytes to fix the buffer to
+
| colspan="2" | The number of bytes to fix the buffer to&nbsp;
−
:''The default value for this parameter is: '''''0x10000'''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
−
[[Variable Types|BOOL]] ''Write''
+
| width="90%" | Write
−
:Set to enable write access
+
|-
−
:''The default value for this parameter is: '''''0'''
+
| colspan="2" | Set to enable write access&nbsp;
−
 
+
|-
−
[[Variable Types|BOOL]] ''Monitor''
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
−
:Set to enable monitoring of the file
+
| width="90%" | Monitor
−
:''The default value for this parameter is: '''''0'''
+
|-
−
 
+
| colspan="2" | Set to enable monitoring of the file&nbsp;
−
 
+
|-
−
==Return value==
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
−
[[Variable Types|HANDLE]]
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
 
+
|}
−
''<span style="color:red;">No additional information</span>''
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png Create
Creates the new file as a circular buffer 
Fc9-string-icon.png - STRING Filename
The name of a new file to create 
Fc9-u32-icon.png - ULONG Bytes
The number of bytes to fix the buffer to 
Fc9-bool-icon.png - BOOL Write
Set to enable write access 
Fc9-bool-icon.png - BOOL Monitor
Set to enable monitoring of the file 
Fc9-h32-icon.png - HANDLE Return


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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_File.Buffer.Create&oldid=29998"