<!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 a directory entry for reading</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.zip-entry-name.html">zip_entry_name</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.zip-entry-read.html">zip_entry_read</a></div>
<div class="up"><a href="ref.zip.html">Zip Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.zip-entry-open" class="refentry">
<div class="refnamediv">
<h1 class="refname">zip_entry_open</h1>
<p class="verinfo">(PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0)</p><p class="refpurpose"><span class="refname">zip_entry_open</span> — <span class="dc-title">Open a directory entry for reading</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.zip-entry-open-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>zip_entry_open</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$zip</code></span>
, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$zip_entry</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$mode</code></span>
] )</div>
<p class="para rdfs-comment">
Opens a directory entry in a zip file for reading.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.zip-entry-open-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">zip</code></em></span>
<dd>
<p class="para">
A valid resource handle returned by <span class="function"><a href="function.zip-open.html" class="function">zip_open()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">zip_entry</code></em></span>
<dd>
<p class="para">
A directory entry returned by <span class="function"><a href="function.zip-read.html" class="function">zip_read()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
Any of the modes specified in the documentation of
<span class="function"><a href="function.fopen.html" class="function">fopen()</a></span>.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Currently, <em><code class="parameter">mode</code></em> is ignored and is always
<em>"rb"</em>. This is due to the fact that zip support
in PHP is read only access.
</p>
</p></blockquote>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.zip-entry-open-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Unlike <span class="function"><a href="function.fopen.html" class="function">fopen()</a></span> and other similar functions,
the return value of <span class="function"><strong>zip_entry_open()</strong></span> only
indicates the result of the operation and is not needed for
reading or closing the directory entry.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.zip-entry-open-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.zip-entry-close.html" class="function" rel="rdfs-seeAlso">zip_entry_close()</a> - Close a directory entry</span></li>
<li class="member"> <span class="function"><a href="function.zip-entry-read.html" class="function" rel="rdfs-seeAlso">zip_entry_read()</a> - Read from an open directory entry</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.zip-entry-name.html">zip_entry_name</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.zip-entry-read.html">zip_entry_read</a></div>
<div class="up"><a href="ref.zip.html">Zip Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
