API File.Buffer.Create: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API File|File]] | ====Class hierarchy==== | ||
[[API File|File]] | |||
:[[API File.Buffer|Buffer]] | :[[API File.Buffer|Buffer]] | ||
::[[API File.Buffer|Create]] | ::[[API File.Buffer|Create]] | ||
| Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|STRING]] ''Filename'' | |||
:The name of a new file to create | :The name of a new file to create | ||
[[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 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 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 29: | ||
[[Variable types|HANDLE]] | [[Variable types|HANDLE]] | ||
No additional information | ''<span style="color:red;">No additional information</span>'' | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 37: | Line 41: | ||
* Declare a variable 'result' of type HANDLE | * 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> | * 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>'' | |||
Revision as of 22:11, 11 May 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