Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ldap_add (3oldap)

Name

ldap_add - Perform an LDAP add operation

Synopsis

#include <ldap.h>

int ldap_add_ext(
LDAP *ld,
const char *dn,
LDAPMod **attrs,
LDAPControl **sctrls,
LDAPControl **cctrls,
int *msgidp );

int ldap_add_ext_s(
LDAP *ld,
const char *dn,
LDAPMod **attrs,
LDAPControl *sctrls,
LDAPControl *cctrls );

Description

LDAP_ADD(3oldap)                                              LDAP_ADD(3oldap)



NAME
       ldap_add_ext, ldap_add_ext_s - Perform an LDAP add operation

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #include <ldap.h>

       int ldap_add_ext(
              LDAP *ld,
              const char *dn,
              LDAPMod **attrs,
              LDAPControl **sctrls,
              LDAPControl **cctrls,
              int *msgidp );

       int ldap_add_ext_s(
              LDAP *ld,
              const char *dn,
              LDAPMod **attrs,
              LDAPControl *sctrls,
              LDAPControl *cctrls );

DESCRIPTION
       The  ldap_add_ext_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_ext(3), and the ldap_op field being used
       only if you need to specify the LDAP_MOD_BVALUES option. Otherwise,  it
       should be set to zero.

       Note  that  all  entries except that specified by the last component in
       the given DN must already  exist.   ldap_add_ext_s()  returns  an  code
       indicating success or, in the case of failure, indicating the nature of
       failure of the operation.  See ldap_error(3) for more details.

       The ldap_add_ext() routine works just like ldap_add_ext_s(), but it  is
       asynchronous.   It  returns the message id of the request it initiated.
       The result of this operation can be obtained by calling ldap_result(3).

DEPRECATED INTERFACES
       The ldap_add() and ldap_add_s() routines are deprecated in favor of the
       ldap_add_ext() and ldap_add_ext_s() routines, respectively.

       Deprecated  interfaces  generally  remain  in  the  library.  The macro
       LDAP_DEPRECATED can be defined to a non-zero value (e.g., -DLDAP_DEPRE-
       CATED=1)  when compiling program designed to use deprecated interfaces.
       It is recommended that developers writing new programs, or updating old
       programs,  avoid  use  of  deprecated  interfaces.   Over  time,  it is
       expected that documentation (and, eventually, support)  for  deprecated
       interfaces to be eliminated.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------------+
       |ATTRIBUTE TYPE |       ATTRIBUTE VALUE        |
       +---------------+------------------------------+
       |Availability   | system/network/ldap/openldap |
       +---------------+------------------------------+
       |Stability      | Pass-through uncommitted     |
       +---------------+------------------------------+

SEE ALSO
       ldap(3), ldap_error(3), ldap_modify(3)

ACKNOWLEDGEMENTS
       OpenLDAP  Software  is developed and maintained by The OpenLDAP Project
       <http://www.openldap.org/>.  OpenLDAP Software is derived from the Uni-
       versity of Michigan LDAP 3.3 Release.



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source  was downloaded from  ftp://ftp.openldap.org/pub/OpenLDAP/openl-
       dap-release/openldap-2.4.59.tgz.

       Further information about this software can be found on the open source
       community website at http://www.openldap.org/.



OpenLDAP 2.4.59                   2021/06/03                  LDAP_ADD(3oldap)