mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
e41aab5eca
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334621 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
3 KiB
XML
130 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- 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 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftruncate</methodname>
|
|
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>size</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Takes the filepointer, <parameter>handle</parameter>, and truncates the file to
|
|
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>
|
|
<note>
|
|
<para>
|
|
The <parameter>handle</parameter> must be open for writing.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>size</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The size to truncate to.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
If <parameter>size</parameter> is larger than the file then the file
|
|
is extended with null bytes.
|
|
</para>
|
|
<para>
|
|
If <parameter>size</parameter> is smaller than the file then the file
|
|
is truncated to that size.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>File truncation example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$filename = 'lorem_ipsum.txt';
|
|
|
|
$handle = fopen($filename, 'r+');
|
|
ftruncate($handle, rand(1, filesize($filename)));
|
|
rewind($handle);
|
|
echo fread($handle, filesize($filename));
|
|
fclose($handle);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
The file pointer is <emphasis>not</emphasis> changed.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>fopen</function></member>
|
|
<member><function>fseek</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|