<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Truncates the file to a given length</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splfileobject.ftell.html">SplFileObject::ftell</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splfileobject.fwrite.html">SplFileObject::fwrite</a></div>
<div class="up"><a href="class.splfileobject.html">SplFileObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="splfileobject.ftruncate" class="refentry">
<div class="refnamediv">
<h1 class="refname">SplFileObject::ftruncate</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">SplFileObject::ftruncate</span> — <span class="dc-title">Truncates the file to a given length</span></p>
</div>
<div class="refsect1 description" id="refsect1-splfileobject.ftruncate-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SplFileObject::ftruncate</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
)</div>
<p class="para rdfs-comment">
Truncates the file to <em><code class="parameter">size</code></em> bytes.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-splfileobject.ftruncate-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">size</code></em></span>
<dd>
<p class="para">
The size to truncate to.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
If <em><code class="parameter">size</code></em> is larger than the file it is extended with null bytes.
</p>
<p class="para">
If <em><code class="parameter">size</code></em> is smaller than the file, the extra data will be lost.
</p>
</p></blockquote>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-splfileobject.ftruncate-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-splfileobject.ftruncate-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3962">
<p><strong>Example #1 <span class="methodname"><strong>SplFileObject::ftruncate()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Create file containing "Hello World!"<br /></span><span style="color: #0000BB">$file </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplFileObject</span><span style="color: #007700">(</span><span style="color: #DD0000">"/tmp/ftruncate"</span><span style="color: #007700">, </span><span style="color: #DD0000">"w+"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #DD0000">"Hello World!"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Truncate to 5 bytes<br /></span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">ftruncate</span><span style="color: #007700">(</span><span style="color: #0000BB">5</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Rewind and read data<br /></span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">rewind</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">fgets</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Hello
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-splfileobject.ftruncate-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ftruncate.html" class="function" rel="rdfs-seeAlso">ftruncate()</a> - Truncates a file to a given length</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splfileobject.ftell.html">SplFileObject::ftell</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splfileobject.fwrite.html">SplFileObject::fwrite</a></div>
<div class="up"><a href="class.splfileobject.html">SplFileObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
