<!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>Returns the current position of the file read/write pointer</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fstat.html">fstat</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftruncate.html">ftruncate</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ftell" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftell</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ftell</span> — <span class="dc-title">Returns the current position of the file read/write pointer</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftell-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ftell</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$handle</code></span>
)</div>
<p class="para rdfs-comment">
Returns the position of the file pointer referenced by <em><code class="parameter">handle</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftell-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">handle</code></em></span>
<dd>
<p class="para">
The file pointer must be valid, and must point to a file successfully
opened by <span class="function"><a href="function.fopen.html" class="function">fopen()</a></span> or <span class="function"><a href="function.popen.html" class="function">popen()</a></span>.
<span class="function"><strong>ftell()</strong></span> gives undefined results for append-only streams
(opened with "a" flag).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftell-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the position of the file pointer referenced by
<em><code class="parameter">handle</code></em> as an integer; i.e., its offset into the file stream.
</p>
<p class="para">
If an error occurs, returns <strong><code>FALSE</code></strong>.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">
Because PHP's integer type is signed and many platforms use 32bit integers,
some filesystem functions may return unexpected results for files which
are larger than 2GB.
</span></p></blockquote>
</div>
<div class="refsect1 examples" id="refsect1-function.ftell-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2395">
<p><strong>Example #1 <span class="function"><strong>ftell()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// opens a file and read some data<br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"/etc/passwd"</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">fgets</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">12</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// where are we ?<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">ftell</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">); </span><span style="color: #FF8000">// 11<br /><br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftell-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.fopen.html" class="function" rel="rdfs-seeAlso">fopen()</a> - Opens file or URL</span></li>
<li class="member"> <span class="function"><a href="function.popen.html" class="function" rel="rdfs-seeAlso">popen()</a> - Opens process file pointer</span></li>
<li class="member"> <span class="function"><a href="function.fseek.html" class="function" rel="rdfs-seeAlso">fseek()</a> - Seeks on a file pointer</span></li>
<li class="member"> <span class="function"><a href="function.rewind.html" class="function" rel="rdfs-seeAlso">rewind()</a> - Rewind the position of a file pointer</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="function.fstat.html">fstat</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftruncate.html">ftruncate</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
