php-doc-en/reference/dio/functions/dio-truncate.xml
Mehdi Achour 4b25f477fe WS
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183659 c90b9560-bf6c-de11-be94-00142212c4b1
2005-04-05 12:51:55 +00:00

79 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.dio-truncate">
<refnamediv>
<refname>dio_truncate</refname>
<refpurpose>
Truncates file descriptor fd to offset bytes
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dio_truncate</methodname>
<methodparam><type>resource</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
<function>dio_truncate</function> truncates a file to at most
<parameter>offset</parameter> bytes in size.
</para>
<para>
If the file previously was larger than this size, the extra data is
lost. If the file previously was shorter, it is unspecified whether the
file is left unchanged or is extended. In the latter case the extended
part reads as zero bytes.
</para>
&note.no-windows;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
The file descriptor returned by <function>dio_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The offset in bytes.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->