Changed <type>int</type> to <type>resource</type> for file handles. Also renamed <parameter>handle</parameter> to <parameter>fp</parameter> for consistency.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@111445 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sara Golemon 2003-01-11 18:20:22 +00:00
parent ed9f38361d
commit b3ad34670f
22 changed files with 51 additions and 49 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fclose">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>fclose</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
The file pointed to by <parameter>fp</parameter> is closed.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.feof">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>feof</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<type>bool</type><methodname>feof</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
Returns &true; if the file pointer is at EOF or an error occurs;

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.43 -->
<refentry id="function.fflush">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>fflush</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<type>bool</type><methodname>fflush</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
This function forces a write of all buffered output to the

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fgetc">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>fgetc</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing a single character read from the

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fgetcsv">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>fgetcsv</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>enclosure</parameter></methodparam>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fgets">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>fgets</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fgetss">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>fgetss</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>allowable_tags</parameter></methodparam>
</methodsynopsis>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.flock">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>flock</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>int</type><parameter>operation</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>&amp;wouldblock</parameter></methodparam>
</methodsynopsis>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fopen">
<refnamediv>
@ -9,7 +9,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>fopen</methodname>
<type>resource</type><methodname>fopen</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter></methodparam>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fpassthru">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>fpassthru</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<simpara>
Reads to EOF on the given file pointer from the current position and
@ -18,7 +18,9 @@
</simpara>
<simpara>
If an error occurs, <function>fpassthru</function> returns
&false;.
&false;. Otherwise, <function>fpassthru</function> returns
the number of characters read from <parameter>fp</parameter>
and passed through to the output.
</simpara>
<simpara>
The file pointer must be valid, and must point to a file successfully

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fputs">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>fputs</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.25 -->
<refentry id="function.fread">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>fread</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<simpara>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fscanf">
<refnamediv>
@ -10,14 +10,14 @@
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>fscanf</methodname>
<methodparam><type>int</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>var1</parameter></methodparam>
</methodsynopsis>
<para>
The function <function>fscanf</function> is similar to
<function>sscanf</function>, but it takes its input from a file
associated with <parameter>handle</parameter> and interprets the
associated with <parameter>fp</parameter> and interprets the
input according to the specified
<parameter>format</parameter>. If only two parameters were passed
to this function, the values parsed will be returned as an array.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fseek">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>fseek</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
</methodsynopsis>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.24 -->
<refentry id="function.fstat">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>fstat</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
Gathers the statistics of the file opened by the file

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.ftell">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ftell</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
Returns the position of the file pointer referenced by fp; i.e.,

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.14 -->
<refentry id="function.ftruncate">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ftruncate</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<type>bool</type><methodname>ftruncate</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.fwrite">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>fwrite</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.pclose">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pclose</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
Closes a file pointer to a pipe opened by

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.popen">
<refnamediv>
@ -9,7 +9,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>popen</methodname>
<type>resource</type><methodname>popen</methodname>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.rewind">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>rewind</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
Sets the file position indicator for fp to the beginning of the

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.32 -->
<refentry id="function.tmpfile">
<refnamediv>
@ -9,7 +9,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tmpfile</methodname>
<type>resource</type><methodname>tmpfile</methodname>
<void/>
</methodsynopsis>
<para>