API File.Buffer.ReadArray: Difference between revisions

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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Reads an array from the input stream, returns elements read
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''ReadArray'''
+|-
+| colspan="2" | Reads an array from the input stream, returns elements read&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | FileHandle
+|-
+| colspan="2" | The handle of an open file&nbsp;
+|-
+| 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&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Elements
+|-
+| colspan="2" | Maximum number of elements to read&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Timeout
+|-
+| colspan="2" | A number of milliseconds to wait for the data to be available&nbsp;
+|-
+| 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''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API File|File]]
-:[[API File.Buffer|Buffer]]
-::[[API File.Buffer|ReadArray]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-[[Variable Types|HANDLE]] ''FileHandle''
-:The handle of an open file
-[[Variable Types|ARRAY]] ''Buffer''
-:An array of some type to read from the file
-[[Variable Types|ULONG]] ''Elements''
-:Maximum number of elements to read
-:''The default value for this parameter is: '''''-1'''
-[[Variable Types|ULONG]] ''Timeout''
-:A number of milliseconds to wait for the data to be available
-:''The default value for this parameter is: '''''0'''
-==Return value==
-[[Variable Types|ULONG]]
-Returns elements read
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 40: / Line 40: @@
 * 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>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation