• Handling errors
  • Position in the file
  • Managing the ANSI/UNICODE format
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
Reads a line in an external file.
PHP In this version, it is only possible to read lines in external files in ANSI format.
WINDEVWEBDEV - Server codeReports and QueriesJavaUser code (UMC)PHPAjax
// Open an external file
FileID = fOpen("C:\MyDirectories\File.txt", foReadWrite)
IF FileID <> -1 THEN
// Read a line in this file
ResRead = fReadLine(FileID)
New in version 28
WINDEVWEBDEV - Server codeReports and QueriesJavaUser code (UMC)Ajax
// Open an external file
MyFile is DiskFile
MyFile = fOpen("C:\MyDirectories\File.txt", foReadWrite)
IF NOT ErrorOccurred THEN
// Read a line in this file
ResRead = fReadLine(MyFile)
<Result> = fReadLine(<File used> [, <Separator>])
<Result>: Character string or UNICODE character string
  • Line read in an external file.
  • EOT constant if the end of file has been reached.
  • Empty string ("") if an error occurred. In this case, the ErrorOccurred variable is set to True.
Remark: A line ends with a CR character (Carriage Return).
PHP This parameter must be a character string.
<File used>: Integer or DiskFile variable
PHP This parameter must be a variant.
<Separator>: Character string
Separator used between the lines. The default separator is the Carriage Return (CR).
PHP This parameter is not available. The separator used is the Carriage return (CR).
New in version 28
AndroidAndroid Widget Java This parameter is now available.

Handling errors

fReadLine throws an error in the following cases:
  • the file is not opened,
  • the file is not accessible in read mode,
  • the file is locked by another computer or by another application. fUnlock is used to unlock an external file.

Position in the file

When opening a file, the current position corresponds to:
  • the first file byte (by default),
  • the last byte of the file is the file is opened in "addition" mode (foAdd constant).
This position can be modified by fSeek.
fReadLine reads the specified elements from the current position. Once fReadLine has been executed, the current position is set to the last byte read. fReadLine returns the EOT constant if the end of the file has been reached.
WINDEVWEBDEV - Server codeReports and QueriesUser code (UMC)Ajax

Managing the ANSI/UNICODE format

The fReadLine function reads:
  • a Unicode string in a Unicode file.
  • an Ansi string in an Ansi file.
The file is created or opened with fCreate/fOpen by specifying the file type.
Depending on the format of the external file used, some conversions are required once a character string was read in an external file:
Current computer
External file
in ANSI format
(fOpen or fCreate associated with the foAnsi constant)
External file
in UNICODE format
(fOpen or fCreate associated with the foUnicode constant)
fReadLine functionPC running WindowsRead operation in ANSI format
Conversion to UNICODE possible with AnsiToUnicode
MobileRead operation in UNICODE format
Conversion to ANSI possible with UnicodeToAnsi

Remark: If the result of fReadLine of an ANSI file is assigned to a UNICODE string (and vice versa), the conversion will be implicitly performed.
For more details, see Managing UNICODE
Business / UI classification: Business Logic
Component: wd280std.dll
Minimum version required
  • Version 9
This page is also available for…
Click [Add] to post a comment