File: ldap-first-attribute.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (59 lines) | stat: -rw-r--r-- 2,126 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 -->
  <refentry id="function.ldap-first-attribute">
   <refnamediv>
    <refname>ldap_first_attribute</refname>
    <refpurpose>Return first attribute</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ldap_first_attribute</methodname>
      <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
      <methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
      <methodparam><type>int</type><parameter role="reference">ber_identifier</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the first attribute in the entry on success and &false; on
     error.
    </para> 
    <para> 
     Similar to reading entries, attributes are also read one by one
     from a particular entry.
     <function>ldap_first_attribute</function> returns the first
     attribute in the entry pointed by the
     <parameter>result_entry_identifier</parameter>.
     Remaining attributes are retrieved by calling
     <function>ldap_next_attribute</function> successively.
     <parameter>ber_identifier</parameter> is the identifier to
     internal memory location pointer. It is passed by reference. The
     same <parameter>ber_identifier</parameter> is passed to the
     <function>ldap_next_attribute</function> function, which modifies
     that pointer.
    </para>
    <para>
     See also <function>ldap_get_attributes</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
-->