sunos man page for ldap_modrdn_s

ldap_modrdn(3LDAP)					      LDAP Library Functions						ldap_modrdn(3LDAP)

NAME
       ldap_modrdn, ldap_modrdn_s, ldap_modrdn2, ldap_modrdn2_s, ldap_rename, ldap_rename_s - modify LDAP entry RDN

SYNOPSIS
       cc[ flag... ] file...- lldap [ library... ]

       #include <lber.h>
       #include <ldap.h>

       int ldap_modrdn(LDAP *ld, const char *dn, const char *newrdn);

       int ldap_modrdn_s(LDAP *ld, const char *dn, const char *newrdn, int deleteoldrdn);

       int ldap_modrdn2(LDAP *ld, const char *dn, const char *newrdn, int deleteoldrdn);

       int ldap_modrdn2_s(LDAP *ld, const char *dn, const char *newrdn, int deleteoldrdn);

       int  ldap_rename(LDAP *ld, const char *dn, const char *newrdn, const char *newparent, int deleteoldrdn, LDAPControl **serverctrls, LDAPCon-
       trol **clientctrls, int *msgidp);

       int ldap_rename_s(LDAP *ld, const char *dn, const char *newrdn, const char *newparent, const int deleteoldrdn,  LDAPControl  **serverctrls,
       LDAPControl **clientctrls);

DESCRIPTION
       The ldap_modrdn() and ldap_modrdn_s() functions perform an LDAP modify RDN (Relative Distinguished Name) operation.  They both take dn, the
       DN (Distinguished Name) of the entry whose RDN is to be changed, and newrdn, the new RDN, to give the entry. The old RDN of  the  entry	is
       never  kept  as an attribute of the entry. ldap_modrdn() is asynchronous. It return the message id of the operation it initiates. ldap_mod-
       rdn_s() is synchronous. It returns the LDAP error code that indicates the success or failure of the operation.

       The ldap_modrdn2() and ldap_modrdn2_s() functions also perform an LDAP modify RDN operation. They take the same parameters  as  above.	In
       addition,  they both take the deleteoldrdn parameter ,which is used as a boolean value to indicate whether or not the old RDN values should
       be deleted from the entry.

       The  ldap_rename(), ldap_rename_s() routines are used to change the name, that is, the RDN of  an  entry.  These  routines  deprecate   the
       ldap_modrdn() and  ldap_modrdn_s() routines, as well as ldap_modrdn2() and ldap_modrdn2_s().

       The  ldap_rename() and  ldap_rename_s() functions both support LDAPv3 server controls and client controls.

ERRORS
       The synchronous (_s) versions of these functions return an LDAP error code, either  LDAP_SUCCESS or an error. See ldap_error(3LDAP).

       The  asynchronous  versions return  -1 in the event of an error, setting the ld_errno field of ld.  See ldap_error(3LDAP) for more details.
       Use ldap_result(3LDAP) to determine a particular unsuccessful result.

ATTRIBUTES
       See attributes(5) for a description of the following attributes of the ldap_modrdn(), ldap_modrdn_s(), ldap_modrdn2() and  ldap_modrdn2_s()
       functions:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWcsl (32-bit)		   |
       +-----------------------------+-----------------------------+
       |			     |SUNWcslx (64-bit) 	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Obsolete			   |
       +-----------------------------+-----------------------------+

       The ldap_rename() and  ldap_rename_s() functions have the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWcsl (32-bit)		   |
       +-----------------------------+-----------------------------+
       |			     |SUNWcslx (64-bit) 	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       ldap(3LDAP), ldap_error(3LDAP) , attributes(5)

SunOS 5.10							   22 Octo 2001 						ldap_modrdn(3LDAP)