php-doc-en/reference/ldap/functions/ldap-err2str.xml
2003-12-15 16:55:22 +00:00

63 lines
1.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ldap.xml, last change in rev 1.12 -->
<refentry id="function.ldap-err2str">
<refnamediv>
<refname>ldap_err2str</refname>
<refpurpose>
Convert LDAP error number into string error message
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ldap_err2str</methodname>
<methodparam><type>int</type><parameter>errno</parameter></methodparam>
</methodsynopsis>
<para>
Returns string error message.</para>
<para>
This function returns the string error message explaining the
error number <parameter>errno</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>
See also <function>ldap_errno</function> and
<function>ldap_error</function>.
<example>
<title>Enumerating all LDAP error messages</title>
<programlisting role="php">
<![CDATA[
<?php
for ($i=0; $i<100; $i++) {
printf("Error $i: %s<br />\n", ldap_err2str($i));
}
?>
]]>
</programlisting>
</example></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:"../../../../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
-->