<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ldap-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_error</refname>
  <refpurpose>Return the LDAP error message of the last LDAP command</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>ldap_error</methodname>
   <methodparam><type>resource</type><parameter>ldap</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the string error message explaining the error generated by the
   last LDAP command for the given <parameter>ldap</parameter>.
   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.
  </para>
  <para>
   Unless you lower your warning level in your &php.ini; sufficiently or
   prefix your LDAP commands with <literal>@</literal> (at) characters to
   suppress warning output, the errors generated will also show up in your
   HTML output.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ldap</parameter></term>
     <listitem>
      <para>
       &ldap.parameter.ldap;
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns string error message.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ldap_err2str</function></member>
    <member><function>ldap_errno</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->