Difference between revisions of "API File.Buffer.Open"
From Flowcode Help
Jump to navigationJump to search (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|Open]] | ::[[API File.Buffer|Open]] | ||
| Line 10: | Line 11: | ||
==Parameters== | ==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''' | ||
| Line 24: | Line 25: | ||
[[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 33: | Line 37: | ||
* 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.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 information</span>'' | ||
Revision as of 22:11, 11 May 2013
<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 information
