Text$ = ReadString(#File [, Flags [, Length]])
Read a string from a file until an 'End Of Line' character is found (Unix, DOS and Macintosh file formats are supported).


#File The file to read from.
Flags (optional) The flags to apply while reading the string. It may be one of the following values:
  #PB_Ascii  : reads the string as ASCII, even when the program is compiled in unicode mode
  #PB_UTF8   : reads the string as UTF8, even when the program is compiled in ASCII mode
  #PB_Unicode: reads the string as UTF16 (the program may be either in unicode or ASCII mode).
combined with:
  #PB_File_IgnoreEOL: ignores the end of line (but the resulting string will still contain them) until the specified
                      length or the end of file.
If this parameter is not specified, the string is read as UTF8 if the program is compiled in unicode mode, else it is read as ASCII.
Length (optional) Read the file until the length (in characters) have been reached. If an end of line is encountered before the length is reached, the read will stop (unless the flag #PB_File_IgnoreEOL has been set).

Return value

Returns the read string, or an empty string if the read has failed.


For detecting the string encoding format (byte order mark) used in a file there is the ReadStringFormat() function available.

For an example see the ReadFile().

See Also

WriteString(), ReadStringFormat(), OpenFile(), ReadFile()

Supported OS


<- ReadQuad() - File Index - ReadStringFormat() ->