API File.Create: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API File|File]] | ====Class hierarchy==== | ||
[[API File|File]] | |||
:[[API File|Create]] | :[[API File|Create]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|STRING]] ''Filename'' | |||
:A textual filename to create | :A textual filename to create | ||
[[Variable types|BOOL]] ''Read'' | |||
:Set to enable read access | :Set to enable read access | ||
[[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 23: | ||
[[Variable types|HANDLE]] | [[Variable types|HANDLE]] | ||
No additional information | ''<span style="color:red;">No additional information</span>'' | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 31: | Line 35: | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* 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>'' | |||
Revision as of 22:11, 11 May 2013
<sidebar>API contents</sidebar> Creates the new file as a standard stream
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
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