LDAP_ADD(3) LDAP_ADD(3)
NAME
ldap_add, ldap_add_s, ldap_add_ext, ldap_add_ext_s - Perform an LDAP
add operation
LIBRARY
OpenLDAP LDAP (libldap, -lldap)
SYNOPSIS
#include <ldap.h>
int ldap_add(LDAP *ld(1,8), const char *dn, LDAPMod *attrs[]);
int ldap_add_s(LDAP *ld(1,8), const char *dn, LDAPMod *attrs[]);
int ldap_add_ext(LDAP *ld(1,8), const char *dn, LDAPMod *attrs[],
LDAPControl *sctrls[], LDAPControl *cctrls[], int *msgidp);
int ldap_add_ext_s(LDAP *ld(1,8), const char *dn, LDAPMod *attrs[],
LDAPControl *sctrls[], LDAPControl *cctrls[]);
DESCRIPTION
The ldap_add_s() routine is used to perform an LDAP add operation. It
takes dn, the DN of the entry to add, and attrs, a null-terminated
array of the entry's attributes. The LDAPMod structure is used to rep-
resent attributes, with the mod_type and mod_values fields being used
as described under ldap_modify(3), and the ldap_op field being used
only if(3,n) you need to specify the LDAP_MOD_BVALUES option. Otherwise, it
should be set(7,n,1 builtins) to zero.
Note that all entries except that specified by the last component in(1,8)
the given DN must already exist. ldap_add_s() returns an LDAP error(8,n)
code indicating success or failure of the operation. See ldap_error(3)
for more details.
The ldap_add() routine works just like ldap_add_s(), but it is asyn-
chronous. It returns the message id of the request it initiated. The
result of this operation can be obtained by calling ldap_result(3).
The ldap_add_ext() routine allows server and client controls to be
specified to extend the add request. This routine is asynchronous like
ldap_add(), but its return value is an LDAP error(8,n) code. It stores the
message id of the request in(1,8) the integer pointed to by msgidp.
The ldap_add_ext_s() routine is the synchronous version(1,3,5) of
ldap_add_ext(). It also returns an LDAP error(8,n) code indicating success
or failure of the operation.
ERRORS
ldap_add() returns -1 in(1,8) case of error(8,n) initiating the request, and will
set(7,n,1 builtins) the ld_errno field in(1,8) the ld(1,8) parameter to indicate the error.
ldap_add_s() will return an LDAP error(8,n) code directly (LDAP_SUCCESS if(3,n)
everything went ok, some error(8,n) otherwise). ldap_add_ext() and
ldap_add_ext_s() also directly return LDAP error(8,n) codes.
SEE ALSO
ldap(3,5,n)(3), ldap_modify(3)
ACKNOWLEDGEMENTS
OpenLDAP is developed and maintained by The OpenLDAP Project
(http://www.openldap.org/). OpenLDAP is derived from University of
Michigan LDAP 3.3 Release.
OpenLDAP 2.2.15 2004/07/27 LDAP_ADD(3)