View source for API File.Buffer.ReadArray

<sidebar>API contents</sidebar>
Reads an array from the input stream, returns elements read

<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API File|File]]
:[[API File.Buffer|Buffer]]
::[[API File.Buffer|ReadArray]]
</div>
__TOC__

==Parameters==
[[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>''


==Examples==
===Calling in a calculation===
* 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>''