git.sur5r.net Git - openldap/blob - doc/man/man3/ldap_delete.3

   1 .TH LDAP_DELETE 3 "22 September 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 ldap_delete, ldap_delete_s \- Perform an LDAP delete operation
   4 .SH SYNOPSIS
   5 .nf
   6 .ft B
   7 #include <lber.h>
   8 #include <ldap.h>
   9 .LP
  10 .ft B
  11 int ldap_delete_s(ld, dn)
  12 .ft
  13 LDAP *ld;
  14 char *dn;
  15 .LP
  16 .ft B
  17 int ldap_delete(ld, dn)
  18 .ft
  19 LDAP *ld;
  20 char *dn;
  21 .SH DESCRIPTION
  22 The
  23 .B ldap_delete_s()
  24 routine is used to perform an LDAP delete operation
  25 synchronously.  It takes \fIdn\fP, the DN of the entry to be deleted.
  26 It returns an LDAP error code, indicating the success or failure of the
  27 operation.
  28 .LP
  29 The
  30 .B ldap_delete()
  31 routine is used to perform an LDAP delete operation
  32 asynchronously.  It takes the same parameters as
  33 .BR ldap_delete_s() ,
  34 but returns the message id of the request it initiated.  The result of
  35 the delete can be obtained by a subsequent call to
  36 .BR ldap_result (3).
  37 .SH ERRORS
  38 .B ldap_delete_s()
  39 returns an LDAP error code which can be interpreted
  40 by calling one of
  41 .BR ldap_perror (3)
  42 and friends.
  43 .B ldap_delete()
  44 returns -1 if something went wrong initiating the request.  It returns the
  45 non-negative message id of the request if things went ok.
  46 .SH SEE ALSO
  47 .BR ldap(3),
  48 .BR ldap_error(3)
  49 .SH ACKNOWLEDGEMENTS
  50 .B      OpenLDAP
  51 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  52 .B      OpenLDAP
  53 is derived from University of Michigan LDAP 3.3 Release.