ldap_abandon

TriggerTek Logo
abcdefghijklmnopqrstuvwxyz_
LDAP_ABANDON(3)						      LDAP_ABANDON(3)



NAME
       ldap_abandon, ldap_abandon_ext - Abandon an LDAP operation in progress

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #include <ldap.h>

       int ldap_abandon(LDAP *ld, int msgid);

       int ldap_abandon_ext(LDAP *ld, int msgid,
	      LDAPControl *sctrls[], LDAPControl *cctrls[]);

DESCRIPTION
       The ldap_abandon() routine is used to abandon or cancel an LDAP opera-
       tion  in	 progress.   The  msgid passed should be the message id of an
       outstanding LDAP operation, as returned by  ldap_search(3),  ldap_mod-
       ify(3), etc.

       ldap_abandon()  checks  to  see	if  the	 result	 of the operation has
       already come in.	 If it has, it deletes it from the queue  of  pending
       messages.   If not, it sends an LDAP abandon operation to the the LDAP
       server.

       The caller can expect that the result of an abandoned  operation	 will
       not be returned from a future call to ldap_result(3).

       ldap_abandon_ext()  is  equivalent  to  ldap_abandon()  except that it
       allows server and client controls to be passed in sctrls	 and  cctrls,
       respectively.

ERRORS
       ldap_abandon()  returns 0 if everything goes ok, -1 otherwise, setting
       ld_errno with an appropriate LDAP error code.

       ldap_abandon_ext() directly returns an LDAP error code indicating suc-
       cess or failure of the operation.

       See ldap_error(3) for details.

SEE ALSO
       ldap(3), ldap_result(3), ldap_error(3)

ACKNOWLEDGEMENTS
       OpenLDAP	  is   developed  and  maintained  by  The  OpenLDAP  Project
       (http://www.openldap.org/).  OpenLDAP is derived	 from  University  of
       Michigan LDAP 3.3 Release.



OpenLDAP 2.2.13			  2004/06/10		      LDAP_ABANDON(3)