php-doc-en/reference/dio/functions/dio-truncate.xml
2004-09-07 21:36:22 +00:00

50 lines
1.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dio.xml, last change in rev 1.1 -->
<refentry id="function.dio-truncate">
<refnamediv>
<refname>dio_truncate</refname>
<refpurpose>
Truncates file descriptor fd to offset bytes
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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 <function>dio_truncate</function> causes the file
referenced by <parameter>fd</parameter> to be truncated to at
most <parameter>offset</parameter> bytes in size. 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. &return.success;.
</para>
&note.no-windows;
</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
-->