cvs: phpdoc /en/reference/filesystem/functions ftruncate.xml

bjori Sun Sep 2 22:03:34 2007 UTC Modified files: /phpdoc/en/reference/filesystem/functions ftruncate.xml Log: New-doc-style http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/ftruncate.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/filesystem/functions/ftruncate.xml diff -u phpdoc/en/reference/filesystem/functions/ftruncate.xml:1.10 phpdoc/en/reference/filesystem/functions/ftruncate.xml:1.11 --- phpdoc/en/reference/filesystem/functions/ftruncate.xml:1.10 Sun Sep 2 21:40:46 2007 +++ phpdoc/en/reference/filesystem/functions/ftruncate.xml Sun Sep 2 22:03:33 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.14 --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ftruncate"> <refnamediv> <refname>ftruncate</refname> <refpurpose>Truncates a file to a given length</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ftruncate</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> @@ -15,23 +15,78 @@ </methodsynopsis> <para> Takes the filepointer, <parameter>handle</parameter>, and truncates the file to - length, <parameter>size</parameter>. &return.success; + length, <parameter>size</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>handle</parameter></term> + <listitem> + <para> + The file pointer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + The size to truncate to. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>PHP 4.3.3</entry> + <entry> + Prior to this release <function>ftruncate</function> returned an + <type>integer</type> value of 1 on success, instead of + <type>boolean</type> &true;. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> <para> The file pointer is <emphasis>not</emphasis> changed. </para> </note> - <note> - <para> - Prior to PHP 4.3.3, <function>ftruncate</function> returns an - <type>integer</type> value of 1 on success, instead of - <type>boolean</type> &true;. - </para> - </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fopen</function> and - <function>fseek</function>. + <simplelist> + <member><function>fopen</function></member> + <member><function>fseek</function></member> + </simplelist> </para> </refsect1> </refentry>