<!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>Open gz-file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gzinflate.html">gzinflate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gzpassthru.html">gzpassthru</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.gzopen" class="refentry">
<div class="refnamediv">
<h1 class="refname">gzopen</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">gzopen</span> — <span class="dc-title">Open gz-file</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gzopen-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>gzopen</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$mode</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">
Opens a gzip (.gz) file for reading or writing.
</p>
<p class="para">
<span class="function"><strong>gzopen()</strong></span> can be used to read a file which is
not in gzip format; in this case <span class="function"><a href="function.gzread.html" class="function">gzread()</a></span> will
directly read from the file without decompression.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gzopen-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.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
As in <span class="function"><a href="function.fopen.html" class="function">fopen()</a></span> (<em>rb</em> or
<em>wb</em>) but can also include a compression level
(<em>wb9</em>) or a strategy: <em>f</em> for
filtered data as in <em>wb6f</em>, <em>h</em> for
<em>Huffman only compression</em> as in <em>wb1h</em>.
(See the description of <em>deflateInit2</em>
in <var class="filename">zlib.h</var> for
more information about the strategy parameter.)
</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.gzopen-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a file pointer to the file opened, after that, everything you read
from this file descriptor will be transparently decompressed and what you
write gets compressed.
</p>
<p class="para">
If the open fails, the function returns <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gzopen-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-821">
<p><strong>Example #1 <span class="function"><strong>gzopen()</strong></span> Example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">gzopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"/tmp/file.gz"</span><span style="color: #007700">, </span><span style="color: #DD0000">"r"</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-function.gzopen-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.gzclose.html" class="function" rel="rdfs-seeAlso">gzclose()</a> - Close an open gz-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.gzinflate.html">gzinflate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gzpassthru.html">gzpassthru</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>
