<!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>Adds a comment to your image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.combineimages.html">Imagick::combineImages</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.compareimagechannels.html">Imagick::compareImageChannels</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.commentimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::commentImage</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::commentImage</span> — <span class="dc-title">Adds a comment to your image</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.commentimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::commentImage</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$comment</code></span>
)</div>
<p class="para rdfs-comment">
Adds a comment to your image.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.commentimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">comment</code></em></span>
<dd>
<p class="para">
The comment to add
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.commentimage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-imagick.commentimage-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.commentimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3315">
<p><strong>Example #1 Using <span class="function"><strong>Imagick::commentImage()</strong></span>:</strong></p>
<div class="example-contents"><p>
Commenting an image and retrieving the comment:
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* Create new Imagick object */<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= new </span><span style="color: #0000BB">imagick</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* Create an empty image */<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">newImage</span><span style="color: #007700">(</span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">, new </span><span style="color: #0000BB">ImagickPixel</span><span style="color: #007700">(</span><span style="color: #DD0000">"red"</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">/* Add comment to the image */<br /></span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">commentImage</span><span style="color: #007700">(</span><span style="color: #DD0000">"Hello World!"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Display the comment */<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$im</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageProperty</span><span style="color: #007700">(</span><span style="color: #DD0000">"comment"</span><span style="color: #007700">);<br /><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="imagick.combineimages.html">Imagick::combineImages</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.compareimagechannels.html">Imagick::compareImageChannels</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
