external/bsd/openldap/man/ldap_rename.3

   1 .TH LDAP_RENAME 3 "2008/07/16" "OpenLDAP 2.4.11"
   2 .\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap_rename.3,v 1.1.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_rename, ldap_rename_s \- Renames the specified entry.
   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_rename( ld, dn, newrdn, newparent, deleteoldrdn, sctrls[], cctrls[], msgidp );
  16 .ft
  17 LDAP *ld;
  18 const char *dn, *newrdn, *newparent;
  19 int deleteoldrdn;
  20 LDAPControl *sctrls[], *cctrls[];
  21 int *msgidp);
  22 .LP
  23 .ft B
  24 int ldap_rename_s( ld, dn, newrdn, newparent, deleteoldrdn, sctrls[], cctrls[] );
  25 .ft
  26 LDAP *ld;
  27 const char *dn, *newrdn, *newparent;
  28 int deleteoldrdn;
  29 LDAPControl *sctrls[], *cctrls[];
  30 .SH DESCRIPTION
  31 These routines are used to perform a LDAP rename operation.
  32 The function changes the leaf component of an entry's distinguished
  33 name and  optionally moves the entry to a new parent container. The
  34 .B ldap_rename_s
  35 performs a rename operation synchronously.
  36 The method takes \fIdn\fP, which points to the distinguished name of
  37 the entry whose attribute is being compared, \fInewparent\fP,the distinguished
  38 name of the entry's new parent. If this parameter is NULL, only the RDN is changed.
  39 The root DN is specified by passing a zero length string, "".
  40 \fIdeleteoldrdn\fP specifies whether the old RDN should be retained or deleted.
  41 Zero indicates that the old RDN should be retained. If you choose this option,
  42 the attribute will contain both names (the old and the new).
  43 Non-zero indicates that the old RDN should be deleted.
  44 \fIserverctrls\fP points to an array of LDAPControl structures that list the
  45 client controls to use with this extended operation. Use NULL to specify
  46 no client controls. \fIclientctrls\fP points to an array of LDAPControl
  47 structures that list the client controls to use with the search.
  48 .LP
  49 .B ldap_rename
  50 works just like
  51 .B ldap_rename_s,
  52 but the operation is asynchronous. It returns the message id of the request
  53 it initiated. The result of this operation can be obtained by calling
  54 .BR ldap_result(3).
  55 .SH ERRORS
  56 .B ldap_rename()
  57 returns -1 in case of error initiating the request, and
  58 will set the \fIld_errno\fP field in the \fIld\fP parameter to
  59 indicate the error.
  60 .BR ldap_rename_s()
  61 returns the LDAP error code resulting from the rename operation.
  62 .SH SEE ALSO
  63 .BR ldap (3),
  64 .BR ldap_modify (3)
  65 .SH ACKNOWLEDGEMENTS
  66 .\" Shared Project Acknowledgement Text
  67 .B "OpenLDAP Software"
  68 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
  69 .B "OpenLDAP Software"
  70 is derived from University of Michigan LDAP 3.3 Release.