ldap_rename_s(3LDAP)

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | ERRORS | ATTRIBUTES | SEE ALSO

NAME

ldap_modrdn, ldap_modrdn_s, ldap_rename, ldap_rename_s- modify LDAP entry RDN

SYNOPSIS

cc[ flag... ] file... -lldap[ library... ]
$(OS_DIR)/lib/libldap.a
#include <lber.h>
#include <ldap.h>

int ldap_modrdn(LDAP **ld, char **dn, char **newrdn);
int ldap_modrdn_s(LDAP **ld, char **dn, char **newrdn, int deleteoldrdn);
int ldap_rename(LDAP *ld, char *dn, char *newrdn, char *newparent, int deleteoldrdn, LDAPControl **serverctrls, LDAPControl **clientctrls, int *msgidp);
int ldap_rename_s(LDAP *ld, char *dn, char *newrdn, char *newparent, int deleteoldrdn, LDAPControl **serverctrls, LDAPControl **clientctrls);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

DESCRIPTION

The ldap_modrdn() and ldap_modrdn_s() functions perform an LDAP modify RDN (Relative Distinguished Name) operation. They both take dn , the DN 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, returning the message id of the operation it initiates. ldap_modrdn_s() is synchronous, returning the LDAP error code indicating the success or failure of the operation. Use of these functions is deprecated. Use the versions described below instead.

The ldap_modrdn_s() routine is deprecated and the ldap_rename() and ldap_rename_s() routines are used instead.

The ldap_rename() , ldap_rename_s() routines are used to change the name, that is, the rdn of an entry. These routines deprecate ldap_modrdn() and ldap_modrdn_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 case of trouble, setting the ld_errno field of ld . See ldap_error() for more details. Use ldap_result(3LDAP) to determine a particular unsuccessful result.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

ldap(3LDAP) , ldap_error(3LDAP)

ChorusOS 5.0  Last Revised 25 May 1998

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | ERRORS | ATTRIBUTES | SEE ALSO