API File.Buffer.ReadArray: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|HANDLE]] ''FileHandle'' | ||
:The handle of an open file | :The handle of an open file | ||
[[Variable | [[Variable Types|ARRAY]] ''Buffer'' | ||
:An array of some type to read from the file | :An array of some type to read from the file | ||
[[Variable | [[Variable Types|ULONG]] ''Elements'' | ||
:Maximum number of elements to read | :Maximum number of elements to read | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
[[Variable | [[Variable Types|ULONG]] ''Timeout'' | ||
:A number of milliseconds to wait for the data to be available | :A number of milliseconds to wait for the data to be available | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| Line 27: | Line 27: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|ULONG]] | ||
Returns elements read | Returns elements read | ||
Revision as of 11:08, 10 June 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)
No additional information