git.sur5r.net Git - openldap/blob - doc/man/man3/ldap_modrdn.3

   1 .TH LDAP_MODRDN 3  "1 December 1994" "U-M LDAP LDVERSION"
   2 .SH NAME
   3 ldap_modrdn, ldap_modrdn_s, ldap_modrdn2, ldap_modrdn2_s \- Perform an LDAP modify RDN operation
   4 .SH SYNOPSIS
   5 .nf
   6 .ft B
   7 #include <lber.h>
   8 #include <ldap.h>
   9 .LP
  10 .ft B
  11 int ldap_modrdn(ld, dn, newrdn)
  12 .ft
  13 LDAP \(**ld;
  14 char \(**dn, \(**newrdn;
  15 .LP
  16 .ft B
  17 .LP
  18 .ft B
  19 int ldap_modrdn_s(ld, dn, newrdn)
  20 .ft
  21 LDAP \(**ld;
  22 char \(**dn, \(**newrdn;
  23 .LP
  24 .ft B
  25 int ldap_modrdn2(ld, dn, newrdn, deleteoldrdn)
  26 .ft
  27 LDAP \(**ld;
  28 char \(**dn, \(**newrdn;
  29 int deleteoldrdn;
  30 .LP
  31 .ft B
  32 int ldap_modrdn2_s(ld, dn, newrdn, deleteoldrdn)
  33 .ft
  34 LDAP \(**ld;
  35 char \(**dn, \(**newrdn;
  36 int deleteoldrdn;
  37 .SH DESCRIPTION
  38 The
  39 .B ldap_modrdn()
  40 and
  41 .B ldap_modrdn_s()
  42 routines perform an LDAP modify
  43 RDN operation.  They both take \fIdn\fP, the DN of the entry whose
  44 RDN is to be changed, and \fInewrdn\fP, the new RDN to give the entry.
  45 The old RDN of the entry is never kept as an attribute of the entry.
  46 .B ldap_modrdn()
  47 is asynchronous, returning the message id of the operation
  48 it initiates.
  49 .B ldap_modrdn_s()
  50 is synchronous, returning the LDAP error
  51 code indicating the success or failure of the operation.  Use of
  52 these routines is deprecated.  Use the versions described below
  53 instead.
  54 .LP
  55 The
  56 .B ldap_modrdn2()
  57 and
  58 .B ldap_modrdn2_s()
  59 routines also perform an LDAP
  60 modify RDN operation, taking the same parameters as above.  In addition,
  61 they both take the \fIdeleteoldrdn\fP parameter which is used as a boolean
  62 value to indicate whether the old RDN values should be deleted from
  63 the entry or not.
  64 .SH ERRORS
  65 The synchronous (_s) versions of these routines return an LDAP error
  66 code, either LDAP_SUCCESS or an error if there was trouble.
  67 The asynchronous versions return -1 in case
  68 of trouble, setting the
  69 .B ld_errno
  70 field of \fIld\fP.  See
  71 .BR ldap_error (3)
  72 for more details.
  73 .SH SEE ALSO
  74 .BR ldap (3),
  75 .BR ldap_error (3)