php-doc-en/reference/ldap/functions/ldap-first-entry.xml
Rui Hirokawa 0afa2e0bf9 fixed a typo.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@103341 c90b9560-bf6c-de11-be94-00142212c4b1
2002-11-11 15:14:26 +00:00

52 lines
1.7 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-first-entry">
<refnamediv>
<refname>ldap_first_entry</refname>
<refpurpose>Return first result id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>ldap_first_entry</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns the result entry identifier for the first entry on
success and &false; on error.</para>
<para>
Entries in the LDAP result are read sequentially using the
<function>ldap_first_entry</function> and
<function>ldap_next_entry</function>
functions. <function>ldap_first_entry</function> returns the
entry identifier for first entry in the result. This entry
identifier is then supplied to
<function>ldap_next_entry</function> routine to get successive
entries from the result.</para>
<para>
See also <function>ldap_get_entries</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
-->