A
          / \      _             Play Now                         Nemesis on 
          | |     | |  _______   _        _   _______    _______   _    _______
          | |\    | | |   ____| |  \    /  | |   ____|  /   ____| | |  /   ____|
 /-------/-------------------------------------------------------------------,
O= Home <=XX|  About  News  Pics  Adventurers  Wizards  Download  Connect     >
 \-------\-------------------------------------------------------------------'
          | |   \   | |  |____  | |      | | |  |____   ___ \  \  | |  ___ \  \
          | |     \_| |_______| |_|      |_| |_______| |_______/  |_| |_______/
          \ /
           V  

Documentation Area

Document Path: /doc/efun/read_file

NAME: read_file

SYNTAX:
	mixed read_file(string file, int start, int length)

DESCRIPTION:
	Returns the contents of the file 'file' as one large string including
	linefeed characters. The second and third arguments are optional.
	The second specifies a line within the file where to start reading,
	the third a maximum lines to read. Default for the second is 0, the
	default for the third is the file size or when start is not 0 , 
	length - start.

NOTE:
	The second and third arguments are lines in the file, NOT characters!
	You can read a file starting with the 10th line and a length of 20
	lines.

RETURN VALUE:
	Either returns the content of the file, if successful or 0 when not
	successful (either file does not exist or is unreadable).

See also:
efun/file_size
efun/file_date
efun/cat
efun/write_file