<!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>Close RAR archive and free all resources</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.rararchive.html">RarArchive</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rararchive.getcomment.html">RarArchive::getComment</a></div>
<div class="up"><a href="class.rararchive.html">RarArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="rararchive.close" class="refentry">
<div class="refnamediv">
<h1 class="refname">RarArchive::close</h1>
<h1 class="refname">rar_close</h1>
<p class="verinfo">(PECL rar >= 2.0.0)</p><p class="refpurpose"><span class="refname">RarArchive::close</span> -- <span class="refname">rar_close</span> — <span class="dc-title">Close RAR archive and free all resources</span></p>
</div>
<div class="refsect1 description" id="refsect1-rararchive.close-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style (method):</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>RarArchive::close</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style:</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>rar_close</strong></span>
( <span class="methodparam"><span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> <code class="parameter">$rarfile</code></span>
)</div>
<p class="para rdfs-comment">
Close RAR archive and free all allocated resources.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-rararchive.close-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">rarfile</code></em></span>
<dd>
<p class="para">
A <span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> object, opened with <span class="function"><a href="rararchive.open.html" class="function">rar_open()</a></span>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-rararchive.close-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>
</div>
<div class="refsect1 changelog" id="refsect1-rararchive.close-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>2.0.0</td>
<td>
The RAR entries returned by <span class="methodname"><a href="rararchive.getentry.html" class="methodname">RarArchive::getEntry()</a></span>
and <span class="methodname"><a href="rararchive.getentries.html" class="methodname">RarArchive::getEntries()</a></span> are now invalidated when
calling this method. This means that all instance methods called for
such entries and not guaranteed to succeed.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-rararchive.close-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-745">
<p><strong>Example #1 Object oriented style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$rar_arch </span><span style="color: #007700">= </span><span style="color: #0000BB">RarArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'latest_winrar.rar'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">.</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">.</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar"
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar" (closed)
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-746">
<p><strong>Example #2 Procedural style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$rar_arch </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'latest_winrar.rar'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">.</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">rar_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">.</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.rararchive.html">RarArchive</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rararchive.getcomment.html">RarArchive::getComment</a></div>
<div class="up"><a href="class.rararchive.html">RarArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
