Difference between revisions of "API File.ReadArray"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import of updated API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
Reads an array from the file, returns elements read
 
Reads an array from the file, returns elements read
Line 36: Line 38:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.ReadArray(filehandle, _arraybuffer, elements)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.ReadArray(filehandle, _arraybuffer, elements)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Reads an array from the file, returns elements read

Class hierarchy

File

ReadArray

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

ULONG

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