Source of: /manual/en/function.gzseek.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.zlib.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.gzseek.php',
1 => 'gzseek',
),
'up' =>
array (
0 => 'ref.zlib.php',
1 => 'Zlib Functions',
),
'prev' =>
array (
0 => 'function.gzrewind.php',
1 => 'gzrewind',
),
'next' =>
array (
0 => 'function.gztell.php',
1 => 'gztell',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.gzseek" class="refentry">
<div class="refnamediv">
<h1 class="refname">gzseek</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">gzseek</span> — <span class="dc-title">Seek on a gz-file pointer</span></p>
</div>
<a name="function.gzseek.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>gzseek</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$zp</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$offset</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$whence</tt><span class="initializer"> = SEEK_SET</span></span>
] )</div>
<p class="para rdfs-comment">
Sets the file position indicator for the given file pointer to the
given offset byte into the file stream. Equivalent to calling (in C)
<i>gzseek(zp, offset, SEEK_SET)</i>.
</p>
<p class="para">
If the file is opened for reading, this function is emulated but
can be extremely slow. If the file is opened for writing, only
forward seeks are supported; <b>gzseek()</b> then compresses
a sequence of zeroes up to the new starting position.
</p>
</div>
<a name="function.gzseek.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">zp</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The gz-file pointer. It must be valid, and must point to a file
successfully opened by <a href="function.gzopen.php" class="function">gzopen()</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">offset</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The seeked offset.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">whence</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
<i><tt class="parameter">whence</tt></i>
values are:
</p><ul class="simplelist">
<li class="member"><b><tt class="constant">SEEK_SET</tt></b> - Set position equal to <i><tt class="parameter">offset</tt></i>
bytes.</li>
<li class="member"><b><tt class="constant">SEEK_CUR</tt></b> - Set position to current location plus <i><tt class="parameter">offset</tt></i>
.</li>
</ul><p>
</p>
<p class="para">
If <i><tt class="parameter">whence</tt></i>
is not specified, it is assumed to be
<b><tt class="constant">SEEK_SET</tt></b>.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.gzseek.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Upon success, returns 0; otherwise, returns -1. Note that seeking
past EOF is not considered an error.
</p>
</div>
<a name="function.gzseek.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>gzseek()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$gz </span><span style="color: #007700">= </span><span style="color: #0000BB">gzopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'somefile.gz'</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">gzseek</span><span style="color: #007700">(</span><span style="color: #0000BB">$gz</span><span style="color: #007700">,</span><span style="color: #0000BB">2</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">gzgetc</span><span style="color: #007700">(</span><span style="color: #0000BB">$gz</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">gzclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$gz</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.gzseek.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.gztell.php" class="function" rel="rdfs-seeAlso">gztell()</a> - Tell gz-file pointer read/write position</li>
<li class="member"><a href="function.gzrewind.php" class="function" rel="rdfs-seeAlso">gzrewind()</a> - Rewind the position of a gz-file pointer</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
