Difference between revisions of "API File.ReadArray"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 19: Line 19:
 
: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'''
 +
  
 
==Return value==
 
==Return value==
Line 24: Line 25:
  
 
Returns elements read
 
Returns elements read
 +
  
 
==Detailed description==
 
==Detailed description==

Revision as of 01:55, 12 May 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 information