reference/filesystem/functions/fstat.xml
0c9c2dd669fe9395eaa73d487fbd160f9057429a
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fstat">
3
+
<refentry xml:id="function.fstat" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>fstat</refname>
6
6
<refpurpose>Gets information about a file using an open file pointer</refpurpose>
...
...
@@ -9,12 +9,12 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>array</type><methodname>fstat</methodname>
13
-
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
12
+
<type class="union"><type>array</type><type>false</type></type><methodname>fstat</methodname>
13
+
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
Gathers the statistics of the file opened by the file
17
-
pointer <parameter>handle</parameter>. This function is similar to the
17
+
pointer <parameter>stream</parameter>. This function is similar to the
18
18
<function>stat</function> function except that it operates
19
19
on an open file pointer instead of a filename.
20
20
</para>
...
...
@@ -25,7 +25,7 @@
25
25
<para>
26
26
<variablelist>
27
27
<varlistentry>
28
-
<term><parameter>handle</parameter></term>
28
+
<term><parameter>stream</parameter></term>
29
29
<listitem>
30
30
&fs.file.pointer;
31
31
</listitem>
...
...
@@ -39,6 +39,7 @@
39
39
<para>
40
40
Returns an array with the statistics of the file; the format of the array
41
41
is described in detail on the <function>stat</function> manual page.
42
+
Returns &false; on failure.
42
43
</para>
43
44
</refsect1>
44
45

...
...
@@ -97,7 +98,6 @@ Array
97
98
</refsect1>
98
99

99
100
</refentry>
100
-

101
101
<!-- Keep this comment at the end of the file
102
102
Local variables:
103
103
mode: sgml
104
104