Skip to main content

read_file

Discworld driver help

read_file

Name

read_file() - read a file into a string

Synopsis

string read_file( string file );
string read_file( string file, int start_line );
string read_file( string file, int start_line, int number_of_lines );

Description

Read a line of text from `file' into a string. The second and third arguments are optional. If only the first argument is specified, the entire file is returned (as a string).

`start_line' is the line number of the line you wish to read. This routine will return 0 if you try to read past the end of the file, or if you try to read from a non positive line.

See also

write_file(), read_buffer()