<!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>Get text for collator's last error code</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="collator.geterrorcode.html">Collator::getErrorCode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="collator.getlocale.html">Collator::getLocale</a></div>
<div class="up"><a href="class.collator.html">Collator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="collator.geterrormessage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Collator::getErrorMessage</h1>
<h1 class="refname">collator_get_error_message</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">Collator::getErrorMessage</span> -- <span class="refname">collator_get_error_message</span> — <span class="dc-title">Get text for collator's last error code</span></p>
</div>
<div class="refsect1 description" id="refsect1-collator.geterrormessage-description">
<h3 class="title">Description</h3>
<p class="para">
Object oriented style
</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">string</span>
<span class="methodname"><strong>Collator::getErrorMessage</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type">string</span>
<span class="methodname"><strong>collator_get_error_message</strong></span>
( <span class="methodparam"><span class="type"><a href="class.collator.html" class="type Collator">Collator</a></span> <code class="parameter">$coll</code></span>
)</div>
<p class="para rdfs-comment">
Retrieves the message for the last error.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-collator.geterrormessage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">coll</code></em></span>
<dd>
<p class="para">
<a href="class.collator.html" class="classname">Collator</a> object.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-collator.geterrormessage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Description of an error occurred in the last Collator <acronym title="Application Programming Interface">API</acronym> function call.
</p>
</div>
<div class="refsect1 examples" id="refsect1-collator.geterrormessage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2494">
<p><strong>Example #1 <span class="function"><strong>collator_get_error_message()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$coll </span><span style="color: #007700">= </span><span style="color: #0000BB">collator_create</span><span style="color: #007700">( </span><span style="color: #DD0000">'lt' </span><span style="color: #007700">);<br />if( </span><span style="color: #0000BB">collator_compare</span><span style="color: #007700">( </span><span style="color: #0000BB">$coll</span><span style="color: #007700">, </span><span style="color: #DD0000">'y'</span><span style="color: #007700">, </span><span style="color: #DD0000">'k' </span><span style="color: #007700">) === </span><span style="color: #0000BB">false </span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">collator_get_error_message</span><span style="color: #007700">( </span><span style="color: #0000BB">$coll </span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-collator.geterrormessage-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="collator.geterrorcode.html" class="function" rel="rdfs-seeAlso">collator_get_error_code()</a> - Get collator's last error code</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="collator.geterrorcode.html">Collator::getErrorCode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="collator.getlocale.html">Collator::getLocale</a></div>
<div class="up"><a href="class.collator.html">Collator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
