Difference between revisions of "API File.Create"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Creates the new file as a standard stream
 
Creates the new file as a standard stream
  
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|STRING]] ''Filename''
+
[[Variable Types|STRING]] ''Filename''
 
:A textual filename to create
 
:A textual filename to create
  
[[Variable types|BOOL]] ''Read''
+
[[Variable Types|BOOL]] ''Read''
 
:Set to enable read access
 
:Set to enable read access
  
[[Variable types|BOOL]] ''Monitor''
+
[[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'''
 +
  
 
==Return value==
 
==Return value==
[[Variable types|HANDLE]]
+
[[Variable Types|HANDLE]]
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
 
  
  
Line 36: Line 36:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Create("filename", true, false)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Create("filename", true, false)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Creates the new file as a standard stream

Class hierarchy

File

Create

Parameters

STRING Filename

A textual filename to create

BOOL Read

Set to enable read access

BOOL Monitor

Set to enable monitoring of the file
The default value for this parameter is: 0


Return value

HANDLE

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.Create("filename", true, false)

No additional examples