API File.Buffer.ReadArray

From Flowcode Help
Revision as of 21:54, 12 May 2013 by Admin (talk | contribs) (XML import)
Jump to navigationJump to search

<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 information