Difference between revisions of "API File.Create"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Creates the new file as a standard stream
 
Creates the new file as a standard stream
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:File
 +
::Create
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|STRING]] Filename''
 
''[[Variable types|STRING]] Filename''
 
:A textual filename to create
 
:A textual filename to create
Line 14: Line 20:
 
:''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]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[C]">result = ::File.Create("filename", true, false)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Create("filename", true, false)</pre>

Revision as of 21:13, 11 May 2013

<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)