API File.Buffer.Create: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	Create
Creates the new file as a circular buffer
- STRING	Filename
The name of a new file to create
- ULONG	Bytes
The number of bytes to fix the buffer to
- BOOL	Write
Set to enable write access
- BOOL	Monitor
Set to enable monitoring of the file
- HANDLE	Return

Detailed description

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)

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Creates the new file as a circular buffer
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''Create'''
+|-
+| colspan="2" | Creates the new file as a circular buffer&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Filename
+|-
+| colspan="2" | The name of a new file to create&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Bytes
+|-
+| colspan="2" | The number of bytes to fix the buffer to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Write
+|-
+| colspan="2" | Set to enable write access&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Monitor
+|-
+| colspan="2" | Set to enable monitoring of the file&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API File|File]]
-:[[API File.Buffer|Buffer]]
-::[[API File.Buffer|Create]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-[[Variable Types|STRING]] ''Filename''
-:The name of a new file to create
-[[Variable Types|ULONG]] ''Bytes''
-:The number of bytes to fix the buffer to
-:''The default value for this parameter is: '''''0x10000'''
-[[Variable Types|BOOL]] ''Write''
-:Set to enable write access
-:''The default value for this parameter is: '''''0'''
-[[Variable Types|BOOL]] ''Monitor''
-:Set to enable monitoring of the file
-:''The default value for this parameter is: '''''0'''
-==Return value==
-[[Variable Types|HANDLE]]
-''<span style="color:red;">No additional information</span>''
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 41: / Line 40: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Create("filename", bytes, false, true)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation