Difference between revisions of "API File.ReadArray"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import of API auto-gen)
Line 25: Line 25:
 
====Calling in a calculation====
 
====Calling in a calculation====
 
* Declare a variable 'result' of type ULONG
 
* Declare a variable 'result' of type ULONG
* Add to a calculation icon: result = ::File.ReadArray(filehandle, _arraybuffer, elements)
+
* Add to a calculation icon: <pre class="brush:[C]">result = ::File.ReadArray(filehandle, _arraybuffer, elements)</pre>

Revision as of 15:35, 10 May 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

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)