API File.ReadArray: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==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'' | ||
:The maximum number of elements to read into the array | :The maximum number of elements to read into the array | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| Line 22: | Line 22: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|ULONG]] | ||
Returns elements read | Returns elements read | ||
Revision as of 11:09, 10 June 2013
<sidebar>API contents</sidebar> Reads an array from the file, 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
- The maximum number of elements to read into the array
- The default value for this parameter is: -1
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.ReadArray(filehandle, _arraybuffer, elements)
No additional information