Mercurial > irccd
annotate doc/html/api/module/Irccd.File/method/constructor.md @ 27:12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 20 Feb 2016 10:35:43 +0100 |
parents | 392778b6d3c9 |
children | 904ee87bc808 |
rev | line source |
---|---|
0 | 1 --- |
2 method: constructor | |
3 summary: "Open a file specified by path with the specified mode." | |
4 synopsis: "Irccd.File(path, mode) /* constructor */" | |
5 arguments: | |
24
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
6 - "**path**: the path to the file," |
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
7 - "**mode**: the mode 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 | 9 --- |
10 | |
13
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
11 ## Mode |
0 | 12 |
13
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
13 The mode is the same as the `fopen(3)`, see the documentation of [std::fopen(3)][fopen] for more information |
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
14 about the mode string. |
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
15 |
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
16 [fopen]: http://en.cppreference.com/w/cpp/io/c/fopen |