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

   1 .TH LDAP_DELETE 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2003 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 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 .SH DESCRIPTION
  26 The
  27 .B ldap_delete_s()
  28 routine is used to perform an LDAP delete operation
  29 synchronously.  It takes \fIdn\fP, the DN of the entry to be deleted.
  30 It returns an LDAP error code, indicating the success or failure of the
  31 operation.
  32 .LP
  33 The
  34 .B ldap_delete()
  35 routine is used to perform an LDAP delete operation
  36 asynchronously.  It takes the same parameters as
  37 .BR ldap_delete_s() ,
  38 but returns the message id of the request it initiated.  The result of
  39 the delete can be obtained by a subsequent call to
  40 .BR ldap_result (3).
  41 .SH ERRORS
  42 .B ldap_delete_s()
  43 returns an LDAP error code which can be interpreted
  44 by calling one of
  45 .BR ldap_perror (3)
  46 and friends.
  47 .B ldap_delete()
  48 returns -1 if something went wrong initiating the request.  It returns the
  49 non-negative message id of the request if things went ok.
  50 .SH SEE ALSO
  51 .BR ldap (3),
  52 .BR ldap_error (3)
  53 .SH ACKNOWLEDGEMENTS
  54 .B OpenLDAP
  55 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  56 .B OpenLDAP
  57 is derived from University of Michigan LDAP 3.3 Release.