Mercurial > irccd

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
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 function: stat
260
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
3 js: true
27
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
4 summary: >
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
5 Get file information at the specified path.
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
6
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
7 The returned object may have the following properties if they are available on your system:
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
8
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
9 - **atime**: (int) the last access time,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
10 - **blksize**: (int) the block size,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
11 - **blocks**: (int) the number of blocks,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
12 - **ctime**: (int) the creation time,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
13 - **dev**: (int) the device,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
14 - **gid**: (int) the group,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
15 - **ino**: (int) the inode,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
16 - **mode**: (int) the mode,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
17 - **mtime**: (int) the modification time,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
18 - **nlink**: (int) the number of hard links,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
19 - **rdev**: (int),
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
20 - **size**: (int) the file size,
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
21 - **uid**: (int) the user.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 synopsis: "info = Irccd.File.stat(path)"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 arguments:
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
24 - "**path**: the path to the file."
13
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
25 returns: "The stat information."
27
12dfbec74a9c Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
26 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
27 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
13
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
29 ## Remarks
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
30
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
31 <div class="alert alert-warning" role="alert">
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
32 **Warning**: this function is optional and may not be available on your system.
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
33 </div>