Difference between revisions of "API File.Buffer.Open"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Opens the existing file as a circular buffer | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API File|File]] | ||
| + | :[[API File.Buffer|Buffer]] | ||
| + | ::[[API File.Buffer|Open]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|STRING]] ''Filename'' | |
:The name of an existing file to open | :The name of an existing file to open | ||
| − | + | [[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''' | ||
| − | |||
| − | |||
| − | No additional information | + | ==Return value== |
| + | [[Variable Types|HANDLE]] | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
| + | |||
| − | + | ==Detailed description== | |
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| − | + | ||
| − | + | ==Examples== | |
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
| − | * Add to a calculation icon: result = ::File.Buffer.Open("filename", true, false) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Open("filename", true, false)</pre> |
| + | |||
| + | ''<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
