From 0b2543e52abdff6badbc73cc1fe9142a357e5c29 Mon Sep 17 00:00:00 2001
From: Daniel Beckham <danbeck@php.net>
Date: Mon, 31 Jul 2000 14:41:42 +0000
Subject: [PATCH] added fstat function, man there are a lot of missing function
 docs. =)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@29409 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/filesystem.xml | 47 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/functions/filesystem.xml b/functions/filesystem.xml
index d0944e2e87..caf8fe7a07 100644
--- a/functions/filesystem.xml
+++ b/functions/filesystem.xml
@@ -1280,6 +1280,53 @@ fclose ($fd);
    </refsect1>
   </refentry>
 
+  <refentry id="function.fstat">
+   <refnamediv>
+    <refname>fstat</refname>
+    <refpurpose>
+     Get information about a file using an open file pointer.
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>array <function>fstat</function></funcdef>
+      <paramdef>int <parameter>fp</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     Gathers the statistics of the file opened by the file
+     pointer fp.  This function is similar to the
+     <function>stat</function> function except that it operates
+     on an open file pointer instead of a filename.
+    </para>
+    <para>
+     Returns an array with the statistics of the file with the
+     following elements:
+     <orderedlist>
+      <listitem><simpara>device</simpara></listitem>
+      <listitem><simpara>inode</simpara></listitem>
+      <listitem><simpara>number of links</simpara></listitem>
+      <listitem><simpara>user id of owner</simpara></listitem>
+      <listitem><simpara>group id owner</simpara></listitem>
+      <listitem><simpara>device type if inode device *</simpara></listitem>
+      <listitem><simpara>size in bytes</simpara></listitem>
+      <listitem><simpara>time of last access</simpara></listitem>
+      <listitem><simpara>time of last modification</simpara></listitem>
+      <listitem><simpara>time of last change</simpara></listitem>
+      <listitem><simpara>blocksize for filesystem I/O *</simpara></listitem>
+      <listitem><simpara>number of blocks allocated</simpara></listitem>
+     </orderedlist>
+     * - only valid on systems supporting the st_blksize type--other
+     systems (i.e. Windows) return -1</para>
+    <para>
+     The results of this function are cached. See
+     <function>clearstatcache</function> for more details.
+    </para>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.ftell">
    <refnamediv>
     <refname>ftell</refname>