mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
106 lines
2.9 KiB
XML
106 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.ldap-first-attribute" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ldap_first_attribute</refname>
|
|
<refpurpose>Return first attribute</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>ldap_first_attribute</methodname>
|
|
<methodparam><type>resource</type><parameter>ldap</parameter></methodparam>
|
|
<methodparam><type>resource</type><parameter>entry</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets the first attribute in the given entry. Remaining attributes are
|
|
retrieved by calling <function>ldap_next_attribute</function> successively.
|
|
</para>
|
|
<para>
|
|
Similar to reading entries, attributes are also read one by one from a
|
|
particular entry.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>ldap</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
&ldap.parameter.ldap;
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>entry</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>ber_identifier</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<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
|
|
<function>ldap_next_attribute</function> , which modifies that
|
|
pointer.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This parameter is no longer used as this is now handled automatically
|
|
by PHP. For backwards compatibility PHP will not throw an error if
|
|
this parameter is passed.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the first attribute in the entry on success and &false; on
|
|
error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ldap_next_attribute</function></member>
|
|
<member><function>ldap_get_attributes</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
|
|
-->
|