Documentation

FileReadArray

Reads from a file of BIN type arrays of any type except string (may be an array of structures, not containing strings, and dynamic arrays).

uint  FileReadArray(
   int  file_handle                 // File handle
   void  array[],                   // Array to record
   int   start_item=0,              // start array position to write
   int   items_count=WHOLE_ARRAY    // count to read
   );

Parameters

file_handle

[in]  File descriptor returned by FileOpen().

array[]

[out] An array where the data will be loaded.

start_item=0

[in]  Start position to write to the array.

items_count=WHOLE_ARRAY

[in]  Number of elements to read. By default, reads the entire array (cnt=WHOLE_ARRAY).

Return Value

Number of elements read.

Note

String array can be read only from the file of TXT type. If necessary, the function tries to increase the size of the array.

See also

Variables