1 NAME
2 read_file - read a file
3
4 SYNOPSIS
5 string read_file(string file, varargs int offset, int size)
6
7
8 DESCRIPTION
9 Read a file. The optional second and third arguments specify an
10 offset in the file and the maximum length of the string to be read,
11 and default to the whole file from the beginning. The offset may
12 be specified as negative, to read from the end of a file. Nil is
13 returned if the file does not exist.
14
15 ERRORS
16 If the offset is out of range or the returned string would be too
17 large, an error will result.
18
19 SEE ALSO
20 kfun/editor, kfun/write_file
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.
