usr/src/man/man3ldap/ldap_modrdn.3ldap

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH LDAP_MODRDN 3LDAP "Oct 22, 2001"
   8 .SH NAME
   9 ldap_modrdn, ldap_modrdn_s, ldap_modrdn2, ldap_modrdn2_s, ldap_rename,
  10 ldap_rename_s \- modify LDAP entry RDN
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc[ \fIflag\fR... ] \fIfile\fR...\fB-l\fR ldap [ \fIlibrary\fR... ]
  15 #include <lber.h>
  16 #include <ldap.h>
  17
  18 \fBint\fR \fBldap_modrdn\fR(\fBLDAP\fR \fI*ld\fR, \fBconst char\fR \fI*dn\fR, \fBconst char\fR \fI*newrdn\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBldap_modrdn_s\fR(\fBLDAP\fR \fI*ld\fR, \fBconst char\fR \fI*dn\fR, \fBconst char\fR \fI*newrdn\fR,
  24      \fBint\fR \fIdeleteoldrdn\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBldap_modrdn2\fR(\fBLDAP\fR \fI*ld\fR, \fBconst char\fR \fI*dn\fR, \fBconst char\fR \fI*newrdn\fR,
  30      \fBint\fR \fIdeleteoldrdn\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBldap_modrdn2_s\fR(\fBLDAP\fR \fI*ld\fR, \fBconst char\fR \fI*dn\fR,
  36      \fBconst char\fR \fI*newrdn\fR, \fBint\fR \fIdeleteoldrdn\fR);
  37 .fi
  38
  39 .LP
  40 .nf
  41 \fBint\fR \fBldap_rename\fR(\fBLDAP\fR \fI*ld\fR, \fBconst char\fR \fI*dn\fR, \fBconst char\fR \fI*newrdn\fR,
  42      \fBconst char\fR \fI*newparent\fR, \fBint\fR \fIdeleteoldrdn\fR,
  43      \fBLDAPControl\fR \fI**serverctrls\fR, \fBLDAPControl\fR \fI**clientctrls\fR,
  44      \fBint\fR \fI*msgidp\fR);
  45 .fi
  46
  47 .LP
  48 .nf
  49 \fBint\fR \fBldap_rename_s\fR(\fBLDAP\fR \fI*ld\fR, \fBconst char\fR \fI*dn\fR, \fBconst char\fR \fI*newrdn\fR,
  50      \fBconst char\fR \fI*newparent\fR,\ \fBconst int\fR \fIdeleteoldrdn\fR,
  51      \fBLDAPControl\fR \fI**serverctrls\fR,\fBLDAPControl\fR \fI**clientctrls\fR);
  52 .fi
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 The \fBldap_modrdn()\fR and \fBldap_modrdn_s()\fR functions perform an LDAP
  58 modify RDN (Relative Distinguished Name) operation.  They both take \fIdn\fR,
  59 the DN (Distinguished Name) of the entry whose RDN is to be changed, and
  60 \fInewrdn\fR, the new RDN, to give the entry. The old RDN of the entry is never
  61 kept as an attribute of the entry. \fBldap_modrdn()\fR is asynchronous. It
  62 return the message id of the operation it initiates. \fBldap_modrdn_s()\fR is
  63 synchronous. It returns the LDAP error code that indicates the success or
  64 failure of the operation.
  65 .sp
  66 .LP
  67 The \fBldap_modrdn2()\fR and \fBldap_modrdn2_s()\fR functions also perform an
  68 LDAP modify RDN operation. They take the same parameters as above.  In
  69 addition, they both take the \fIdeleteoldrdn\fR parameter ,which is used as a
  70 boolean value to indicate whether or not the old RDN values should be deleted
  71 from the entry.
  72 .sp
  73 .LP
  74 The  \fBldap_rename()\fR, \fBldap_rename_s()\fR routines are used to change the
  75 name, that is, the RDN of an entry. These routines deprecate  the
  76 \fBldap_modrdn()\fR and  \fBldap_modrdn_s()\fR routines, as well as
  77 \fBldap_modrdn2()\fR and \fBldap_modrdn2_s()\fR.
  78 .sp
  79 .LP
  80 The  \fBldap_rename()\fR and  \fBldap_rename_s()\fR functions both support
  81 LDAPv3 server controls and client controls.
  82 .SH ERRORS
  83 .sp
  84 .LP
  85 The synchronous (\fB_s\fR) versions of these functions return an LDAP error
  86 code, either  \fBLDAP_SUCCESS\fR or an error. See \fBldap_error\fR(3LDAP).
  87 .sp
  88 .LP
  89 The asynchronous versions return  \fB\(mi1\fR in the event of an error, setting
  90 the \fBld_errno\fR field of \fIld\fR.  See \fBldap_error\fR(3LDAP) for more
  91 details. Use \fBldap_result\fR(3LDAP) to determine a particular unsuccessful
  92 result.
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for a description of the following attributes of the
  97 \fBldap_modrdn()\fR, \fBldap_modrdn_s()\fR, \fBldap_modrdn2()\fR and
  98 \fBldap_modrdn2_s()\fR functions:
  99 .sp
 100
 101 .sp
 102 .TS
 103 box;
 104 c | c
 105 l | l .
 106 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 107 Interface Stability     Obsolete
 108 .TE
 109
 110 .sp
 111 .LP
 112 The \fBldap_rename()\fR and  \fBldap_rename_s()\fR functions have the following
 113 attributes:
 114 .sp
 115
 116 .sp
 117 .TS
 118 box;
 119 c | c
 120 l | l .
 121 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 122 _
 123 Interface Stability     Evolving
 124 .TE
 125
 126 .SH SEE ALSO
 127 .sp
 128 .LP
 129 \fBldap\fR(3LDAP), \fBldap_error\fR(3LDAP) , \fBattributes\fR(5)