<!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>Output a gz-file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gzwrite.html">gzwrite</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.zlib-decode.html">zlib_decode</a></div>
<div class="up"><a href="ref.zlib.html">Zlib Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.readgzfile" class="refentry">
<div class="refnamediv">
<h1 class="refname">readgzfile</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">readgzfile</span> — <span class="dc-title">Output a gz-file</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.readgzfile-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>readgzfile</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$use_include_path</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Reads a file, decompresses it and writes it to standard output.
</p>
<p class="para">
<span class="function"><strong>readgzfile()</strong></span> can be used to read a file which is not in
gzip format; in this case <span class="function"><strong>readgzfile()</strong></span> will directly
read from the file without decompression.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.readgzfile-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
The file name. This file will be opened from the filesystem and its
contents written to standard output.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">use_include_path</code></em></span>
<dd>
<p class="para">
You can set this optional parameter to <em>1</em>, if you
want to search for the file in the <a href="ini.core.html#ini.include-path" class="link">include_path</a> too.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.readgzfile-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the number of (uncompressed) bytes read from the file. If
an error occurs, <strong><code>FALSE</code></strong> is returned and unless the function was
called as <em>@readgzfile</em>, an error message is
printed.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.readgzfile-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.gzpassthru.html" class="function" rel="rdfs-seeAlso">gzpassthru()</a> - Output all remaining data on a gz-file pointer</span></li>
<li class="member"> <span class="function"><a href="function.gzfile.html" class="function" rel="rdfs-seeAlso">gzfile()</a> - Read entire gz-file into an array</span></li>
<li class="member"> <span class="function"><a href="function.gzopen.html" class="function" rel="rdfs-seeAlso">gzopen()</a> - Open gz-file</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.gzwrite.html">gzwrite</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.zlib-decode.html">zlib_decode</a></div>
<div class="up"><a href="ref.zlib.html">Zlib Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
