API File.Buffer.ReadArray: Difference between revisions
No edit summary |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadArray''' | ||
|- | |- | ||
| colspan="2" | Reads an array from the input stream, returns elements read | | colspan="2" | Reads an array from the input stream, returns elements read | ||
| Line 33: | Line 33: | ||
==Detailed description== | ==Detailed description== | ||
| Line 40: | Line 40: | ||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)</pre> | ||
Latest revision as of 14:11, 13 July 2026
|
ReadArray |
| Reads an array from the input stream, returns elements read | |
 - HANDLE
|
FileHandle |
| The handle of an open file | |
 - ARRAY
|
Buffer |
| An array of some type to read from the file | |
 - ULONG
|
Elements |
| Maximum number of elements to read | |
| - ULONG
|
Timeout |
| A number of milliseconds to wait for the data to be available | |
| - ULONG
|
Return |
Detailed description
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)