API File.Buffer.ReadArray: Difference between revisions

Revision as of 11:41, 16 January 2023

	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

No additional information

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)

No additional examples

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

Wiki bot (talk | contribs)

Revision as of 11:41, 16 January 2023

Detailed description

Examples

Calling in a calculation