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

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2002, 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_ADD 3LDAP "Jan 27, 2002"
   8 .SH NAME
   9 ldap_add, ldap_add_s, ldap_add_ext, ldap_add_ext_s \- perform an LDAP add
  10 operation
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc[ \fIflag\fR... ] \fIfile\fR... -lldap[ \fIlibrary\fR... ]
  15 #include <lber.h>
  16 #include <ldap.h>
  17
  18 \fBint\fR\fBldap_add\fR(\fBLDAP\fR \fI*ld\fR, \fBchar\fR \fI*dn\fR, \fBLDAPMod\fR \fI*attrs\fR[]);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR\fBldap_add_s\fR(\fBLDAP\fR \fI*ld\fR, \fBchar\fR \fI*dn\fR, \fBLDAPMod\fR \fI*attrs\fR[]);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBldap_add_ext\fR(\fBLDAP\fR \fI*ld\fR, \fBchar\fR \fI*dn\fR, \fBLDAPMod\fR \fI**attrs\fR,
  29      \fBLDAPControl\fR \fI**serverctrls\fR,\ \fBint\fR \fI* msgidp\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBldap_add_ext_s\fR(\fBLDAP\fR \fI*ld\fR, \fBchar\fR \fI*dn\fR, \fBLDAPMod\fR \fI**attrs\fR,
  35      \fBLDAPControl\fR \fI**serverctrls\fR, \fBLDAPControl\fR \fI**clientctrls\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBldap_add_s()\fR function is used to perform an LDAP add operation. It
  42 takes \fIdn\fR, the DN of the entry to add, and \fIattrs\fR, a null-terminated
  43 array of the entry's attributes.  The LDAPMod structure is used to represent
  44 attributes, with the \fImod_type\fR and \fImod_values\fR fields being used as
  45 described under \fBldap_modify\fR(3LDAP), and the \fIldap_op\fR field being
  46 used only if you need to specify the  \fBLDAP_MOD_BVALUES\fR option. Otherwise,
  47 it should be set to zero.
  48 .sp
  49 .LP
  50 Note that all entries except that specified by the last component in the given
  51 DN must already exist. \fBldap_add_s()\fR returns an LDAP error code indicating
  52 success or failure of the operation.  See \fBldap_error\fR(3LDAP) for more
  53 details.
  54 .sp
  55 .LP
  56 The \fBldap_add()\fR function works just like \fBldap_add_s()\fR, but it is
  57 asynchronous.  It returns the message id of the request it initiated.  The
  58 result of this operation can be obtained by calling \fBldap_result\fR(3LDAP).
  59 .sp
  60 .LP
  61 The  \fBldap_add_ext()\fR function initiates an asynchronous add operation and
  62 returns  \fBLDAP_SUCCESS\fR if the request was successfully sent to the server,
  63 or else it returns a LDAP error code if not (see  \fBldap_error\fR(3LDAP)). If
  64 successful,  \fBldap_add_ext()\fR \fBplaces\fR \fBthe\fR \fBmessage\fR \fBid\fR
  65 \fBof\fR \fI*msgidp\fR. A subsequent call to  \fBldap_result()\fR, can be used
  66 to obtain the result of the  add request.
  67 .sp
  68 .LP
  69 The  \fBldap_add_ext_s()\fR function initiates a synchronous add operation and
  70 returns the result of the operation itself.
  71 .SH ERRORS
  72 .sp
  73 .LP
  74 \fBldap_add()\fR returns  \fB\(mi1\fR in case of error initiating the request,
  75 and will set the \fIld_errno\fR field in the \fIld\fR parameter to indicate the
  76 error. \fBldap_add_s()\fR will return an LDAP error code directly.
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5) for a description of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 Interface Stability     Evolving
  90 .TE
  91
  92 .SH SEE ALSO
  93 .sp
  94 .LP
  95 \fBldap\fR(3LDAP), \fBldap_error\fR(3LDAP), \fBldap_modify\fR(3LDAP),
  96 \fBattributes\fR(5)