Mercurial > irccd

view doc/html/api/module/Irccd.File/method/constructor.md @ 27:12dfbec74a9c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
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: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures."
---

## 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