external/bsd/openldap/man/ldap_modrdn.3

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