view doc/html/api/module/Irccd.File/method/constructor.md @ 13:070a1ece2af6

Docs: fix various errors in JavaScript API
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2016 22:02:57 +0100
parents 1158cffe5a5e
children 392778b6d3c9
line wrap: on
line source

---
method: constructor
summary: "Open a file specified by path with the specified mode."
synopsis: "Irccd.File(path, mode) /* constructor */"
arguments:
  - "path, the path to the file,"
  - "mode, the mode string."
throws: "Any exception on error."
---

## Mode

The mode is the same as the `fopen(3)`, see the documentation of [std::fopen(3)][fopen] for more information
about the mode string.

[fopen]: http://en.cppreference.com/w/cpp/io/c/fopen