Functions and Directives Functions and Directives

Function FileStr() Foundation

Reads a string from a file starting at a specified position.

Syntax
FileStr( <cFileName>     , ;
         [<nBytesToRead>], ;
         [<nStartOffSet>], ;  // Default: 0
         [<lCtrl_Z>]       ;  // Default: .F.
       ) --> cString
Return

Returns a string read from <cFileName> or a null string if an error occured.

Description

<cFileName>

A string with the name of the file to be read.

<nBytesToRead>

This parameter defaults to the file size, meaning all bytes should be read. This differs from the CA-Tools function where a 64kB limit exists. Although no limit exists for Xbase++ it is recommended not to read more than 500 kB at a time.

<nStartOffSet>

This specifies the number of bytes to be skipped before reading from the file.

<lCtrl_Z>

If this parameter is set .T. reading the file is terminated once Chr(26) (Ctrl+Z) is detected. This is useful for reading Chr(26) terminated DBT memo fields.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.