<!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>Returns the Zip archive comment</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.extractto.html">ZipArchive::extractTo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.getcommentindex.html">ZipArchive::getCommentIndex</a></div>
<div class="up"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ziparchive.getarchivecomment" class="refentry">
<div class="refnamediv">
<h1 class="refname">ZipArchive::getArchiveComment</h1>
<p class="verinfo">(PHP 5 >= 5.2.0, PECL zip >= 1.1.0)</p><p class="refpurpose"><span class="refname">ZipArchive::getArchiveComment</span> — <span class="dc-title">Returns the Zip archive comment</span></p>
</div>
<div class="refsect1 description" id="refsect1-ziparchive.getarchivecomment-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>ZipArchive::getArchiveComment</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
] )</div>
<p class="para rdfs-comment">
Returns the Zip archive comment.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-ziparchive.getarchivecomment-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
If flags is set to <strong><code>ZipArchive::FL_UNCHANGED</code></strong>, the original unchanged
comment is returned.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-ziparchive.getarchivecomment-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the Zip archive comment or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-ziparchive.getarchivecomment-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-790">
<p><strong>Example #1 Dump an archive comment</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'test_with_comment.zip'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">=== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">getArchiveComment</span><span style="color: #007700">());<br /> </span><span style="color: #FF8000">/* Or using the archive property */<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">comment</span><span style="color: #007700">);<br />} else {<br /> echo </span><span style="color: #DD0000">'failed, code:' </span><span style="color: #007700">. </span><span style="color: #0000BB">$res</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.extractto.html">ZipArchive::extractTo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.getcommentindex.html">ZipArchive::getCommentIndex</a></div>
<div class="up"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
