php-doc-en/reference/ldap/functions/ldap-rename.xml
Hartmut Holzgraefe 5b9fc29465 revision tags added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
2002-04-17 06:45:35 +00:00

57 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/ldap.xml, last change in rev 1.24 -->
<refentry id="function.ldap-rename">
<refnamediv>
<refname>ldap_rename</refname>
<refpurpose>Modify the name of an entry</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ldap_rename</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>string</type><parameter>newrdn</parameter></methodparam>
<methodparam><type>string</type><parameter>newparent</parameter></methodparam>
<methodparam><type>bool</type><parameter>deleteoldrdn</parameter></methodparam>
</methodsynopsis>
<para>
The entry specified by <parameter>dn</parameter> is renamed/moved.
The new RDN is specified by <parameter>newrdn</parameter> and the
new parent/superior entry is specified
by <parameter>newparent</parameter>. If the parameter
<parameter>deleteoldrdn</parameter> is &true; the old RDN value(s)
is removed, else the old RDN value(s) is retained as
non-distinguished values of the entry. &return.success;
</para>
<note>
<para>This function currently only works with LDAPv3. You may have
to use <function>ldap_set_option</function> prior to binding to
use LDAPv3. This function is only available when using OpenLDAP 2.x.x OR
Netscape Directory SDK x.x, and was added in PHP 4.0.5.
</para>
</note>
</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
-->