mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
75 lines
2.7 KiB
XML
75 lines
2.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.ldap-read">
|
|
<refnamediv>
|
|
<refname>ldap_read</refname>
|
|
<refpurpose>Read an entry</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>ldap_read</methodname>
|
|
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>filter</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns a search result identifier or &false; on error.</para>
|
|
<para>
|
|
<function>ldap_read</function> performs the search for a
|
|
specified <parameter>filter</parameter> on the directory with the scope
|
|
LDAP_SCOPE_BASE. So it is equivalent to reading an entry from the
|
|
directory.</para>
|
|
<para>
|
|
An empty filter is not allowed. If you want to retrieve
|
|
absolutely all information for this entry, use a filter of
|
|
"objectClass=*". If you know which entry types are used on the
|
|
directory server, you might use an appropriate filter such as
|
|
"objectClass=inetOrgPerson".</para>
|
|
<para>
|
|
This call takes 5 optional parameters. See <function>ldap_search</function>
|
|
notes.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
These optional parameters were added in 4.0.2:
|
|
<parameter>attrsonly</parameter>,
|
|
<parameter>sizelimit</parameter>,
|
|
<parameter>timelimit</parameter>,
|
|
<parameter>deref</parameter>.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
From 4.0.5 on it's also possible to do parallel searches. See
|
|
<function>ldap_search</function> for details.
|
|
</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
|
|
-->
|