<!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>Convert LDAP error number into string error message</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-dn2ufn.html">ldap_dn2ufn</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-errno.html">ldap_errno</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ldap-err2str" class="refentry">
<div class="refnamediv">
<h1 class="refname">ldap_err2str</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ldap_err2str</span> — <span class="dc-title">Convert LDAP error number into string error message</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ldap-err2str-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>ldap_err2str</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$errno</code></span>
)</div>
<p class="para rdfs-comment">
Returns the string error message explaining the error number
<em><code class="parameter">errno</code></em>. While LDAP errno numbers are standardized,
different libraries return different or even localized textual error
messages. Never check for a specific error message text, but always use an
error number to check.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ldap-err2str-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">errno</code></em></span>
<dd>
<p class="para">
The error number.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ldap-err2str-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the error message, as a string.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ldap-err2str-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4396">
<p><strong>Example #1 Enumerating all LDAP error messages</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> </span><span style="color: #007700">for (</span><span style="color: #0000BB">$i</span><span style="color: #007700">=</span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700"><</span><span style="color: #0000BB">100</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Error </span><span style="color: #0000BB">$i</span><span style="color: #DD0000">: %s<br />\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">ldap_err2str</span><span style="color: #007700">(</span><span style="color: #0000BB">$i</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-function.ldap-err2str-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ldap-errno.html" class="function" rel="rdfs-seeAlso">ldap_errno()</a> - Return the LDAP error number of the last LDAP command</span></li>
<li class="member"> <span class="function"><a href="function.ldap-error.html" class="function" rel="rdfs-seeAlso">ldap_error()</a> - Return the LDAP error message of the last LDAP command</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.ldap-dn2ufn.html">ldap_dn2ufn</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-errno.html">ldap_errno</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
