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

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