php-doc-en/reference/ldap/functions/ldap-get-entries.xml
Jakub Vrana f803865331 Xmas typos 3/5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146654 c90b9560-bf6c-de11-be94-00142212c4b1
2003-12-17 14:32:39 +00:00

73 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 -->
<refentry id="function.ldap-get-entries">
<refnamediv>
<refname>ldap_get_entries</refname>
<refpurpose>Get all result entries</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ldap_get_entries</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns a complete result information in a multi-dimensional
array on success and &false; on error.</para>
<para>
<function>ldap_get_entries</function> function is used to
simplify reading multiple entries from the result, specified with
<parameter>result_identifier</parameter>, and then
reading the attributes and multiple values. The entire
information is returned by one function call in a
multi-dimensional array. The structure of the array is as
follows.</para>
<para>
The attribute index is converted to lowercase. (Attributes are
case-insensitive for directory servers, but not when used as
array indices.)
<informalexample>
<literallayout>
return_value["count"] = number of entries in the result
return_value[0] : refers to the details of first entry
return_value[i]["dn"] = DN of the ith entry in the result
return_value[i]["count"] = number of attributes in ith entry
return_value[i][j] = jth attribute in the ith entry in the result
return_value[i]["attribute"]["count"] = number of values for
attribute in ith entry
return_value[i]["attribute"][j] = jth value of attribute in ith entry
</literallayout>
</informalexample></para>
<para>
See also <function>ldap_first_entry</function> and
<function>ldap_next_entry</function></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
-->