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

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