API File.Open: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	Open
Opens the existing file as a standard stream
- STRING	Filename
A textual filename to open
- BOOL	Read
Set to enable read access
- BOOL	Write
Set to enable write access
- BOOL	Monitor
Set to enable monitoring of the file
- 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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Opens the existing file as a standard stream
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''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 File|File]]
-:[[API 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]]
-''<span style="color:red;">No additional information</span>''
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 38: / Line 40: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Open("filename", true, false, true)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation