API File.Buffer.Create: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|STRING]] ''Filename'' | ||
:The name of a new file to create | :The name of a new file to create | ||
[[Variable | [[Variable Types|ULONG]] ''Bytes'' | ||
:The number of bytes to fix the buffer to | :The number of bytes to fix the buffer to | ||
:''The default value for this parameter is: '''''0x10000''' | :''The default value for this parameter is: '''''0x10000''' | ||
[[Variable | [[Variable Types|BOOL]] ''Write'' | ||
:Set to enable write access | :Set to enable write access | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
[[Variable | [[Variable Types|BOOL]] ''Monitor'' | ||
:Set to enable monitoring of the file | :Set to enable monitoring of the file | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| Line 28: | Line 28: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|HANDLE]] | ||
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> 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
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 information