Documented ldap_rename()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@46512 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Stig Venaas 2001-05-03 21:07:25 +00:00
parent d192fa0595
commit f3d07bd963

View file

@ -1366,6 +1366,38 @@ for ($i=0; $i<$info["count"]; $i++)
</refentry>
<refentry id="function.ldap-rename">
<refnamediv>
<refname>ldap_rename</refname>
<refpurpose>Modify the name of an entry</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ldap_rename</function></funcdef>
<paramdef>int <parameter>link_identifier</parameter></paramdef>
<paramdef>string <parameter>dn</parameter></paramdef>
<paramdef>string <parameter>newrdn</parameter></paramdef>
<paramdef>string <parameter>newparent</parameter></paramdef>
<paramdef>boolean <parameter>deleteoldrdn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<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. True is returned on
success and false is returned on error.</para>
<para>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>
</refsect1>
</refentry>
<refentry id="function.ldap-search">
<refnamediv>
<refname>ldap_search</refname>