Difference between revisions of "API File.Open"
From Flowcode Help
Jump to navigationJump to search (XML import of API documentation) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Open''' | ||
| + | |- | ||
| + | | colspan="2" | Opens the existing file as a standard stream | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Filename | ||
| + | |- | ||
| + | | colspan="2" | A textual filename to open | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Read | ||
| + | |- | ||
| + | | colspan="2" | Set to enable read access | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Write | ||
| + | |- | ||
| + | | colspan="2" | Set to enable write access | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Monitor | ||
| + | |- | ||
| + | | colspan="2" | Set to enable monitoring of the file | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | + | ==Detailed description== | |
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| Line 40: | Line 40: | ||
* 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.Open("filename", true, false, true)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Open("filename", true, false, true)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
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)
