Difference between revisions of "API File.Buffer.Open"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Opens the existing file as a circular buffer | Opens the existing file as a circular buffer | ||
| Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Filename'' |
:The name of an existing file to open | :The name of an existing file to open | ||
| − | [[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 24: | Line 24: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] |
| + | |||
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' | ||
| Line 37: | Line 38: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Open("filename", true, false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Open("filename", true, false)</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Opens the existing file as a circular buffer
Contents
Parameters
STRING Filename
- The name of an existing file to open
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.Open("filename", true, false)
No additional examples
