Difference between revisions of "API File.Buffer.Create"
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;" | '''Create''' | ||
| + | |- | ||
| + | | colspan="2" | Creates the new file as a circular buffer | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Filename | ||
| + | |- | ||
| + | | colspan="2" | The name of a new file to create | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Bytes | ||
| + | |- | ||
| + | | colspan="2" | The number of bytes to fix the buffer to | ||
| + | |- | ||
| + | | 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 43: | 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.Buffer.Create("filename", bytes, false, true)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.Create("filename", bytes, false, true)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
Create |
| Creates the new file as a circular buffer | |
 - STRING
|
Filename |
| The name of a new file to create | |
 - ULONG
|
Bytes |
| The number of bytes to fix the buffer to | |
 - 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.Buffer.Create("filename", bytes, false, true)
