API File.Buffer.ReadArray: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy=== | ===Class hierarchy===[[API |API ]] | ||
:File | :[[API File|File]] | ||
::Buffer | ::[[API File.Buffer|Buffer]] | ||
:::ReadArray | :::ReadArray | ||
</div> | </div> | ||
Revision as of 21:19, 11 May 2013
<sidebar>API contents</sidebar> Reads an array from the input stream, returns elements read
Parameters
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
- The default value for this parameter is: -1
ULONG Timeout
- A number of milliseconds to wait for the data to be available
- The default value for this parameter is: 0
Return value
Returns elements read
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)