Jump to content

API File.Create: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import API changes
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
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'''
Line 22: Line 22:


==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>''

Revision as of 11:09, 10 June 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)

No additional information