Mercurial > irccd

annotate doc/html/api/module/Irccd.File/method/read.md @ 254:93a227277786

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: various fixes for further cross-compilation
author David Demelier <markand@malikania.fr>
date Mon, 05 Sep 2016 12:53:13 +0200
parents 12dfbec74a9c
children 904ee87bc808
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 method: read
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "Read the specified amount of characters or the whole file."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 synopsis: "File.prototype.read(amount)"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 arguments:
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
6 - "**amount**: the amount of characters or -1 to read all (Optional, default: -1)."
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 returns: "The string."
27
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
8 throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures."
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 ---