Difference between revisions of "API File.ReadArray"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Reads an array from the file, returns elements read | Reads an array from the file, returns elements read | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :File | ||
| + | ::ReadArray | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] FileHandle'' | ''[[Variable types|HANDLE]] FileHandle'' | ||
:The handle of an open file | :The handle of an open file | ||
| Line 14: | Line 20: | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| − | + | ==Return value== | |
[[Variable types|ULONG]] | [[Variable types|ULONG]] | ||
Returns elements read | Returns elements read | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''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:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.ReadArray(filehandle, _arraybuffer, elements)</pre> |
Revision as of 21:14, 11 May 2013
<sidebar>API contents</sidebar> Reads an array from the file, returns elements read
Class hierarchy
- File
- ReadArray
Contents
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)
