Difference between revisions of "API File.Open"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Opens the existing file as a standard stream
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Open'''
 +
|-
 +
| colspan="2" | Opens the existing file as a standard stream&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Filename
 +
|-
 +
| colspan="2" | A textual filename to open&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Read
 +
|-
 +
| colspan="2" | Set to enable read access&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Write
 +
|-
 +
| colspan="2" | Set to enable write access&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Monitor
 +
|-
 +
| colspan="2" | Set to enable monitoring of the file&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
===Class hierarchy===[[API |API ]]
 
:[[API File|File]]
 
::Open
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
''[[Variable types|STRING]] Filename''
 
:A textual filename to open
 
 
 
''[[Variable types|BOOL]] Read''
 
:Set to enable read access
 
 
 
''[[Variable types|BOOL]] Write''
 
:Set to enable write access
 
 
 
''[[Variable types|BOOL]] Monitor''
 
:Set to enable monitoring of the file
 
:''The default value for this parameter is: '''''0'''
 
  
==Return value==
 
[[Variable types|HANDLE]]
 
  
No additional information
 
 
==Detailed description==
 
''No additional information''
 
  
 
==Examples==
 
==Examples==

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png Open
Opens the existing file as a standard stream 
Fc9-string-icon.png - STRING Filename
A textual filename to open 
Fc9-bool-icon.png - BOOL Read
Set to enable read access 
Fc9-bool-icon.png - BOOL Write
Set to enable write access 
Fc9-bool-icon.png - BOOL Monitor
Set to enable monitoring of the file 
Fc9-h32-icon.png - HANDLE Return


Detailed description

Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::File.Open("filename", true, false, true)