# $file.read

Reads a text file

Syntax

    $file.read(<filename>[,<size>])

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 MB limit (so if you want to read a file that is bigger thatn 1 MB then you MUST specify the <size>).
WARNING: always check the file size before attemting to read a whole file... reading a CDROM iso image may sit down your system :) (and will prolly crash while allocating memory , before attempting to read anything)
An empty string is returned if a serious error occures.
The <filename> is adjusted according to the system that KVIrc is running on.

Examples

        echo $file.read(/proc/cpuinfo)

See also
$file.readbinary

Index, Functions

KVIrc 3.2.0 Documentation
Generated by kris at Wed Oct 25 20:15:27 2006