Difference between revisions of "API File.Buffer.ReadArray"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
(XML import of API documentation)
Line 1: Line 1:
  
  
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Reads an array from the input stream, returns elements read
 
Reads an array from the input stream, returns elements read
  

Revision as of 14:27, 9 August 2013


<sidebar>API Contents</sidebar> Reads an array from the input stream, returns elements read

Class hierarchy

File

Buffer
ReadArray

Parameters

HANDLE FileHandle

The handle of an open file

ARRAY Buffer

An array of some type to read from the file

ULONG Elements

Maximum number of elements to read
The default value for this parameter is: -1

ULONG Timeout

A number of milliseconds to wait for the data to be available
The default value for this parameter is: 0


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.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)

No additional examples