Difference between revisions of "API File.Buffer.ReadArray"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(12 intermediate revisions by 3 users not shown)
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]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
  
−
===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''
+
==Examples==
−
:A number of milliseconds to wait for the data to be available
+
===Calling in a calculation===
−
:''The default value for this parameter is: '''''0'''
 
−
 
 
−
===Return value===
 
−
[[Variable types|ULONG]]
 
−
 
 
−
Returns elements read
 
−
 
 
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation====
 
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
−
* Add to a calculation icon: <pre class="brush:[C]">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 11:55, 16 January 2023

Fc9-comp-macro.png ReadArray
Reads an array from the input stream, returns elements read 
Fc9-h32-icon.png - HANDLE FileHandle
The handle of an open file 
Fc9-void-icon.png - ARRAY Buffer
An array of some type to read from the file 
Fc9-u32-icon.png - ULONG Elements
Maximum number of elements to read 
Fc9-u32-icon.png - ULONG Timeout
A number of milliseconds to wait for the data to be available 
Fc9-u32-icon.png - 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)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_File.Buffer.ReadArray&oldid=30311"