ldap-first-entry.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ldap-first-entry" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_first_entry</refname>
  <refpurpose>Return first result id</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <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 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>
   Entries in the LDAP result are read sequentially using the
   <function>ldap_first_entry</function> and
   <function>ldap_next_entry</function> functions.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>link_identifier</parameter></term>
     <listitem>
      <para>
       An LDAP link identifier, returned by <function>ldap_connect</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result_identifier</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the result entry identifier for the first entry on success and
   &false; on error.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ldap_get_entries</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
-->