Difference between revisions of "API File.NVM.ReadArray"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
|||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Reads an array from the NVM, returns elements read | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadArray''' | ||
| + | |- | ||
| + | | colspan="2" | Reads an array from the NVM, returns elements read | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | FileHandle | ||
| + | |- | ||
| + | | colspan="2" | The handle of an open file | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | Position in the file in bytes | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-void-icon.png]] - ARRAY | ||
| + | | width="90%" | Buffer | ||
| + | |- | ||
| + | | colspan="2" | An array of some type to read from the file | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Elements | ||
| + | |- | ||
| + | | colspan="2" | Maximum number of elements to read | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | === | + | ==Detailed description== |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
| − | * Add to a calculation icon: result = ::File.NVM.ReadArray(filehandle, address, _arraybuffer, elements) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.ReadArray(filehandle, address, _arraybuffer, elements)</pre> |
Latest revision as of 11:55, 16 January 2023
|
ReadArray |
| Reads an array from the NVM, returns elements read | |
 - HANDLE
|
FileHandle |
| The handle of an open file | |
 - ULONG
|
Address |
| Position in the file in bytes | |
 - ARRAY
|
Buffer |
| An array of some type to read from the file | |
| - ULONG
|
Elements |
| Maximum number of elements to read | |
| - ULONG
|
Return |
Detailed description
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::File.NVM.ReadArray(filehandle, address, _arraybuffer, elements)
