external/bsd/openldap/man/ldap_delete.3

   1 .TH LDAP_DELETE 3 "2008/07/16" "OpenLDAP 2.4.11"
   2 .\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap_delete.3,v 1.16.2.3 2008/02/11 23:26:39 kurt Exp $
   3 .\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_delete, ldap_delete_s, ldap_delete_ext, ldap_delete_ext_s \- Perform an LDAP delete operation.
   7 .SH LIBRARY
   8 OpenLDAP LDAP (libldap, -lldap)
   9 .SH SYNOPSIS
  10 .nf
  11 .ft B
  12 #include <ldap.h>
  13 .LP
  14 .ft B
  15 int ldap_delete_s(ld, dn)
  16 .ft
  17 LDAP *ld;
  18 char *dn;
  19 .LP
  20 .ft B
  21 int ldap_delete(ld, dn)
  22 .ft
  23 LDAP *ld;
  24 char *dn;
  25 .LP
  26 .ft B
  27 int ldap_delete_ext(ld, dn, serverctrls, clientctrls, msgidp)
  28 .ft
  29 LDAP *ld;
  30 char *dn;
  31 LDAPControl **serverctrls, **clientctrls;
  32 int *msgidp;
  33 .LP
  34 .ft B
  35 int ldap_delete_ext_s(ld, dn, serverctrls, clientctrls)
  36 .ft
  37 LDAP *ld;
  38 char *dn;
  39 LDAPControl **serverctrls, **clientctrls;
  40 .SH DESCRIPTION
  41 The
  42 .B ldap_delete_s()
  43 routine is used to perform an LDAP delete operation
  44 synchronously. It takes \fIdn\fP, the DN of the entry to be deleted.
  45 It returns an LDAP error code, indicating the success or failure of the
  46 operation.
  47 .LP
  48 The
  49 .B ldap_delete()
  50 routine is used to perform an LDAP delete operation
  51 asynchronously. It takes the same parameters as
  52 .BR ldap_delete_s(),
  53 but returns the message id of the request it initiated. The result of
  54 the delete can be obtained by a subsequent call to
  55 .BR ldap_result (3).
  56 .LP
  57 The
  58 .B ldap_delete_ext()
  59 routine  allows  server  and client controls to be
  60 specified to extend the delete request. This routine is asynchronous like
  61 ldap_delete(), but its return value is an LDAP error code. It stores the
  62 message id of the request in the integer pointed to by msgidp.
  63 .LP
  64 The
  65 .B ldap_delete_ext_s()
  66 routine is the synchronous version of
  67 .BR ldap_delete_ext().
  68 It also returns an LDAP error code indicating success
  69 or failure of the operation.
  70 .SH ERRORS
  71 .B ldap_delete_s()
  72 returns an LDAP error code which can be interpreted
  73 by calling one of
  74 .BR ldap_perror (3)
  75 and friends.
  76 .B ldap_delete()
  77 returns -1 if something went wrong initiating the request. It returns the
  78 non-negative message id of the request if things went ok.
  79 .LP
  80 .B ldap_delete_ext()
  81 and
  82 .B ldap_delete_ext_s()
  83 return some Non-zero value if
  84 something  went wrong initiating the request, else return 0.
  85 .SH SEE ALSO
  86 .BR ldap (3),
  87 .BR ldap_error (3)
  88 .SH ACKNOWLEDGEMENTS
  89 .\" Shared Project Acknowledgement Text
  90 .B "OpenLDAP Software"
  91 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
  92 .B "OpenLDAP Software"
  93 is derived from University of Michigan LDAP 3.3 Release.