Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ldap_delete (3oldap)

Name

ldap_delete - form an LDAP delete operation.

Synopsis

#include <ldap.h>

int ldap_delete_s(ld, dn)
LDAP *ld;
char *dn;

int ldap_delete(ld, dn)
LDAP *ld;
char *dn;

int ldap_delete_ext(ld, dn, serverctrls, clientctrls, msgidp)
LDAP *ld;
char *dn;
LDAPControl **serverctrls, **clientctrls;
int *msgidp;

int ldap_delete_ext_s(ld, dn, serverctrls, clientctrls)
LDAP *ld;
char *dn;
LDAPControl **serverctrls, **clientctrls;

Description

LDAP_DELETE(3oldap)                                        LDAP_DELETE(3oldap)



NAME
       ldap_delete,  ldap_delete_s,  ldap_delete_ext, ldap_delete_ext_s - Per-
       form an LDAP delete operation.

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #include <ldap.h>

       int ldap_delete_s(ld, dn)
       LDAP *ld;
       char *dn;

       int ldap_delete(ld, dn)
       LDAP *ld;
       char *dn;

       int ldap_delete_ext(ld, dn, serverctrls, clientctrls, msgidp)
       LDAP *ld;
       char *dn;
       LDAPControl **serverctrls, **clientctrls;
       int *msgidp;

       int ldap_delete_ext_s(ld, dn, serverctrls, clientctrls)
       LDAP *ld;
       char *dn;
       LDAPControl **serverctrls, **clientctrls;

DESCRIPTION
       The ldap_delete_s() routine is used to perform an LDAP delete operation
       synchronously.  It  takes  dn,  the  DN of the entry to be deleted.  It
       returns an LDAP error code, indicating the success or  failure  of  the
       operation.

       The  ldap_delete()  routine is used to perform an LDAP delete operation
       asynchronously. It takes the same parameters  as  ldap_delete_s(),  but
       returns  the  message id of the request it initiated. The result of the
       delete can be obtained by a subsequent call to ldap_result(3).

       The ldap_delete_ext() routine  allows  server  and client  controls  to
       be specified to extend the delete request. This routine is asynchronous
       like ldap_delete(), but its return value is  an  LDAP  error  code.  It
       stores  the  message  id  of  the  request in the integer pointed to by
       msgidp.

       The  ldap_delete_ext_s()  routine  is  the   synchronous   version   of
       ldap_delete_ext().   It also returns an LDAP error code indicating suc-
       cess or failure of the operation.

ERRORS
       ldap_delete_s() returns an LDAP error code which can be interpreted  by
       calling one of ldap_perror(3) and friends.  ldap_delete() returns -1 if
       something went wrong initiating the request. It returns  the  non-nega-
       tive message id of the request if things went ok.

       ldap_delete_ext() and ldap_delete_ext_s() return some Non-zero value if
       something  went wrong initiating the request, else return 0.


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)

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_DELETE(3oldap)