view doc/html/api/module/Irccd.File/function/stat.md @ 260:904ee87bc808

CMake: split documentation into several topic, closes #535
author David Demelier <markand@malikania.fr>
date Wed, 14 Sep 2016 13:36:06 +0200
parents 12dfbec74a9c
children
line wrap: on
line source

---
function: stat
js: true
summary: >
  Get file information at the specified path.

  The returned object may have the following properties if they are available on your system:

    - **atime**: (int) the last access time,
    - **blksize**: (int) the block size,
    - **blocks**: (int) the number of blocks,
    - **ctime**: (int) the creation time,
    - **dev**: (int) the device,
    - **gid**: (int) the group,
    - **ino**: (int) the inode,
    - **mode**: (int) the mode,
    - **mtime**: (int) the modification time,
    - **nlink**: (int) the number of hard links,
    - **rdev**: (int),
    - **size**: (int) the file size,
    - **uid**: (int) the user.
synopsis: "info = Irccd.File.stat(path)"
arguments:
  - "**path**: the path to the file."
returns: "The stat information."
throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures."
---

## Remarks

<div class="alert alert-warning" role="alert">
**Warning**: this function is optional and may not be available on your system.
</div>