# $file.readLines

Reads lines of a text file

Usage

    $file.readLines(<filename>[,<startline>,[<count>[,<flags>]]])

Description

Reads lines from the specified file and returns them as an array of strings. The lines are assumed to be separated by linefeed characters (which are NOT returned). Eventual terminating carriage return characters at the end of the line are stripped. If <startline> is specified, then all the lines with indexes lower that <startline> are discarded. If <count> is specified then a maximum of <count> lines is returned. If <count> is not specified then all the lines until the end are read. 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 ut8 characters set. If 'l' is present the the file is decoded by using the local 8 bit character set instead. WARNING: Always check the size of the file you're going to read: it is not a good idea attempting to read a 700 MB binary file with this function since it will probably sit down your system and exhaust your virtual memory.

Syntax Specification

    <array> $file.readLines(<filename:string>[,<startline:integer>,[<count:integer>[,<flags:string>]]])

Examples

        echo $file.readLines(/proc/cpuinfo)

See also
$file.read, file.writelines, $lf

Index, Functions

KVIrc 3.4.0 Documentation
Generated by linimon at Wed Dec 3 16:16:57 2008