<!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>Seek to a position</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="splfileobject.fscanf.html">SplFileObject::fscanf</a></div> <div class="next" style="text-align: right; float: right;"><a href="splfileobject.fstat.html">SplFileObject::fstat</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.fseek" class="refentry"> <div class="refnamediv"> <h1 class="refname">SplFileObject::fseek</h1> <p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">SplFileObject::fseek</span> — <span class="dc-title">Seek to a position</span></p> </div> <div class="refsect1 description" id="refsect1-splfileobject.fseek-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>SplFileObject::fseek</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$offset</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$whence</code><span class="initializer"> = SEEK_SET</span></span> ] )</div> <p class="para rdfs-comment"> Seek to a position in the file measured in bytes from the beginning of the file, obtained by adding <em><code class="parameter">offset</code></em> to the position specified by <em><code class="parameter">whence</code></em>. </p> </div> <div class="refsect1 parameters" id="refsect1-splfileobject.fseek-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">offset</code></em></span> <dd> <p class="para"> The offset. A negative value can be used to move backwards through the file which is useful when SEEK_END is used as the <em><code class="parameter">whence</code></em> value. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">whence</code></em></span> <dd> <p class="para"> <em><code class="parameter">whence</code></em> values are: <ul class="simplelist"> <li class="member"><strong><code>SEEK_SET</code></strong> - Set position equal to <em><code class="parameter">offset</code></em> bytes.</li> <li class="member"><strong><code>SEEK_CUR</code></strong> - Set position to current location plus <em><code class="parameter">offset</code></em>.</li> <li class="member"><strong><code>SEEK_END</code></strong> - Set position to end-of-file plus <em><code class="parameter">offset</code></em>.</li> </ul> </p> <p class="para"> If <em><code class="parameter">whence</code></em> is not specified, it is assumed to be <strong><code>SEEK_SET</code></strong>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-splfileobject.fseek-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns 0 if the seek was successful, -1 otherwise. Note that seeking past EOF is not considered an error. </p> </div> <div class="refsect1 examples" id="refsect1-splfileobject.fseek-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3959"> <p><strong>Example #1 <span class="methodname"><strong>SplFileObject::fseek()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$file </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplFileInfo</span><span style="color: #007700">(</span><span style="color: #DD0000">"somefile.txt"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Read first line<br /></span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">fgets</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Move back to the beginning of the file<br />// Same as $file->rewind();<br /></span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">fseek</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-splfileobject.fseek-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <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> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="splfileobject.fscanf.html">SplFileObject::fscanf</a></div> <div class="next" style="text-align: right; float: right;"><a href="splfileobject.fstat.html">SplFileObject::fstat</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>