$file.read
Reads a text file
Usage
<string> $file.read(<filename:string>[,<size:integer>[,<flags:string>]])
Description
Reads at most <size> bytes of the file pointed by <filename>.
<size> is an upper limit but may be not reached if the real file is smaller.
The data read is returned as a string, so if the file contains binary data, expect strange results.
If <size> is not specified, then KVIrc tries to read the whole file up to the 1 MiB limit (so if you want to read a file that is bigger than 1 MiB then you MUST specify the <size>).
If you want read binary data (with null bytes inside) then take a look at $file.readbytes. WARNING: always check the file size before attempting to read a whole file... reading a CDROM ISO image may sit down your system :) (and will probably crash while allocating memory, before attempting to read anything)
An empty string is returned if a serious error occurs.
The <filename> is adjusted according to the system that KVIrc is running on.
Flags are actually limited to the single letter 'l'. By default the file is decoded from the UTF-8 characters set. If 'l' is present the the file is decoded by using the local 8-bit character set instead.
Examples
echo $file.read(/proc/cpuinfo)
See also
$file.readbytes

Index, Functions