Difference between revisions of "API File.ReadArray"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
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==== | ||
+ | [[API File|File]] | ||
+ | :[[API File|ReadArray]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''FileHandle'' | |
:The handle of an open file | :The handle of an open file | ||
− | + | [[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 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''' | ||
− | + | ||
− | [[Variable | + | ==Return value== |
+ | [[Variable Types|ULONG]] | ||
Returns elements read | Returns elements read | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | ''<span style="color:red;">No additional information</span>'' | |
+ | |||
+ | |||
+ | ==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> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Reads an array from the file, returns elements read
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)
No additional examples