From f3d07bd963e1868858b496bbe31e1e48942edf3c Mon Sep 17 00:00:00 2001
From: Stig Venaas <venaas@php.net>
Date: Thu, 3 May 2001 21:07:25 +0000
Subject: [PATCH] Documented ldap_rename()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@46512 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/ldap.xml | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/functions/ldap.xml b/functions/ldap.xml
index 1c692d0359..7893f66d0a 100644
--- a/functions/ldap.xml
+++ b/functions/ldap.xml
@@ -1366,6 +1366,38 @@ for ($i=0; $i&lt;$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>