Mercurial > irccd
annotate doc/html/api/module/Irccd.File/function/stat.md @ 254:93a227277786
Irccd: various fixes for further cross-compilation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 05 Sep 2016 12:53:13 +0200 |
parents | 12dfbec74a9c |
children | 904ee87bc808 |
rev | line source |
---|---|
0 | 1 --- |
2 function: stat | |
27
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
3 summary: > |
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
4 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
|
5 |
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
6 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
|
7 |
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
8 - **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
|
9 - **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
|
10 - **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
|
11 - **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
|
12 - **dev**: (int) the device, |
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
13 - **gid**: (int) the group, |
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
14 - **ino**: (int) the inode, |
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
15 - **mode**: (int) the mode, |
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
16 - **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
|
17 - **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
|
18 - **rdev**: (int), |
12dfbec74a9c
Docs: use Irccd.SystemError in functions throwing that error, #420
David Demelier <markand@malikania.fr>
parents:
24
diff
changeset
|
19 - **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
|
20 - **uid**: (int) the user. |
0 | 21 synopsis: "info = Irccd.File.stat(path)" |
22 arguments: | |
24
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
23 - "**path**: the path to the file." |
13
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
24 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
|
25 throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." |
0 | 26 --- |
27 | |
13
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
28 ## Remarks |
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
29 |
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
30 <div class="alert alert-warning" role="alert"> |
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
31 **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
|
32 </div> |