openldap/doc/man/man3/ldap_abandon.3

.TH LDAP_ABANDON 3 "RELEASEDATE" "OpenLDAP LDVERSION"
.\" $OpenLDAP$
.\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.SH NAME
ldap_abandon_ext \- Abandon an LDAP operation in progress
.SH LIBRARY
OpenLDAP LDAP (libldap, \-lldap)
.SH SYNOPSIS
.nf
.B
#include <ldap.h>
.LP
.ft B
int ldap_abandon_ext(
.RS
.ft B
LDAP *\fIld\fB,
Bint \fImsgid\fB,
LDAPControl **\fIsctrls\fB,
LDAPControl **\fIcctrls\fB );
.RE
.fi
.SH DESCRIPTION
The
.B ldap_abandon_ext()
routine is used to send a LDAP Abandon request for an
operation in progress.  The \fImsgid\fP passed should be the
message id of an outstanding LDAP operation, such as returned by
.BR ldap_search_ext (3).
.LP
.BR ldap_abandon_ext ()
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 request to the LDAP server.
.LP
The caller can expect that the result of an abandoned operation
will not be returned from a future call to
.BR ldap_result (3).
.LP
.B ldap_abandon_ext()
allows server and client controls to be passed in via the
.I sctrls
and
.I cctrls
parameters, respectively.
.LP
.B ldap_abandon_ext()
returns a code indicating success or, in the case of failure, the
nature of the failure.  See
.BR ldap_error (3)
for details.
.SH DEPRECATED INTERFACES
The
.B ldap_abandon()
routine is deprecated in favor of the
.B ldap_abandon_ext()
routine. 
.LP
.so Deprecated

.SH SEE ALSO
.BR ldap (3),
.BR ldap_error (3),
.BR ldap_result (3),
.BR ldap_search_ext (3)
.SH ACKNOWLEDGEMENTS
.so ../Project
Generate man page date from version.sh 2002-06-13 11:59:10 +08:00			`.TH LDAP_ABANDON 3 "RELEASEDATE" "OpenLDAP LDVERSION"`
Add RCSid and Copyright 1999-09-12 12:41:47 +08:00			`.\" $OpenLDAP$`
Update copyright notices 2009-01-22 08:40:04 +08:00			`.\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.`
Add RCSid and Copyright 1999-09-12 12:41:47 +08:00			`.\" Copying restrictions apply. See COPYRIGHT/LICENSE.`
Initial revision 1998-08-09 08:43:13 +08:00			`.SH NAME`
Update ldap_abandon(3) as example as to how to document non-deprecated v. deprecated interfaces. 2006-06-14 06:31:34 +08:00			`ldap_abandon_ext \- Abandon an LDAP operation in progress`
Add LIBRARY section to each man page 2002-06-21 15:32:54 +08:00			`.SH LIBRARY`
ITS#6023 minor formatting tweaks 2009-06-03 08:43:44 +08:00			`OpenLDAP LDAP (libldap, \-lldap)`
Initial revision 1998-08-09 08:43:13 +08:00			`.SH SYNOPSIS`
			`.nf`
Additional updates 2006-06-14 08:17:31 +08:00			`.B`
			`#include <ldap.h>`
			`.LP`
			`.ft B`
			`int ldap_abandon_ext(`
Minor updates, mention extended requests, server and client controls. Please review and comment. 2002-01-13 20:55:55 +08:00			`.RS`
Additional updates 2006-06-14 08:17:31 +08:00			`.ft B`
			`LDAP *\fIld\fB,`
			`Bint \fImsgid\fB,`
			`LDAPControl **\fIsctrls\fB,`
			`LDAPControl **\fIcctrls\fB );`
Minor nroff tweaks. 2003-04-29 23:14:35 +08:00			`.RE`
Minor updates, mention extended requests, server and client controls. Please review and comment. 2002-01-13 20:55:55 +08:00			`.fi`
Initial revision 1998-08-09 08:43:13 +08:00			`.SH DESCRIPTION`
			`The`
Update ldap_abandon(3) as example as to how to document non-deprecated v. deprecated interfaces. 2006-06-14 06:31:34 +08:00			`.B ldap_abandon_ext()`
Another fix 2006-06-14 07:15:06 +08:00			`routine is used to send a LDAP Abandon request for an`
Initial revision 1998-08-09 08:43:13 +08:00			`operation in progress. The \fImsgid\fP passed should be the`
more updates 2006-06-14 08:19:32 +08:00			`message id of an outstanding LDAP operation, such as returned by`
			`.BR ldap_search_ext (3).`
Initial revision 1998-08-09 08:43:13 +08:00			`.LP`
Update ldap_abandon(3) as example as to how to document non-deprecated v. deprecated interfaces. 2006-06-14 06:31:34 +08:00			`.BR ldap_abandon_ext ()`
Initial revision 1998-08-09 08:43:13 +08:00			`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,`
Additional cleanup 2006-06-14 07:09:33 +08:00			`it sends an LDAP abandon request to the LDAP server.`
Initial revision 1998-08-09 08:43:13 +08:00			`.LP`
			`The caller can expect that the result of an abandoned operation`
			`will not be returned from a future call to`
			`.BR ldap_result (3).`
Minor updates, mention extended requests, server and client controls. Please review and comment. 2002-01-13 20:55:55 +08:00			`.LP`
			`.B ldap_abandon_ext()`
Update ldap_abandon(3) as example as to how to document non-deprecated v. deprecated interfaces. 2006-06-14 06:31:34 +08:00			`allows server and client controls to be passed in via the`
Minor updates, mention extended requests, server and client controls. Please review and comment. 2002-01-13 20:55:55 +08:00			`.I sctrls`
			`and`
Update ldap_abandon(3) as example as to how to document non-deprecated v. deprecated interfaces. 2006-06-14 06:31:34 +08:00			`.I cctrls`
			`parameters, respectively.`
Minor updates, mention extended requests, server and client controls. Please review and comment. 2002-01-13 20:55:55 +08:00			`.LP`
Misc updates (based in part on ITS#4590 discussions) 2006-06-16 07:15:31 +08:00			`.B ldap_abandon_ext()`
			`returns a code indicating success or, in the case of failure, the`
			`nature of the failure. See`
Initial revision 1998-08-09 08:43:13 +08:00			`.BR ldap_error (3)`
			`for details.`
Update ldap_abandon(3) as example as to how to document non-deprecated v. deprecated interfaces. 2006-06-14 06:31:34 +08:00			`.SH DEPRECATED INTERFACES`
			`The`
			`.B ldap_abandon()`
			`routine is deprecated in favor of the`
			`.B ldap_abandon_ext()`
			`routine.`
			`.LP`
Tweaks to last commit 2006-06-14 07:07:10 +08:00			`.so Deprecated`
Update ldap_abandon(3) as example as to how to document non-deprecated v. deprecated interfaces. 2006-06-14 06:31:34 +08:00
Initial revision 1998-08-09 08:43:13 +08:00			`.SH SEE ALSO`
Documentation patch #4 (ITS#1749) ================ Written by Hallvard B. Furuseth and placed into the public domain. This software is not subject to any license of the University of Oslo. ================ Small changes: - Fix typo slapd_meta -> slapd-meta in slapd-meta(5). - Add slapd-dnssrv(5) to SEE ALSO in slapd.conf(5). - Add descriptions of the files in FILES sections. - Add $HOME/.udrc to FILES in ud(1) and ud.conf(5). - Add ldaprc (without ".") and ENVIRONMENT VARIABLES in ldap.conf(5). - Change manpage references to proper ".BR name (section)". Hallvard B. Furuseth <h.b.furuseth@usit.uio.no>, May 2002. 2002-05-09 10:07:41 +08:00			`.BR ldap (3),`
more updates 2006-06-14 08:19:32 +08:00			`.BR ldap_error (3),`
Documentation patch #4 (ITS#1749) ================ Written by Hallvard B. Furuseth and placed into the public domain. This software is not subject to any license of the University of Oslo. ================ Small changes: - Fix typo slapd_meta -> slapd-meta in slapd-meta(5). - Add slapd-dnssrv(5) to SEE ALSO in slapd.conf(5). - Add descriptions of the files in FILES sections. - Add $HOME/.udrc to FILES in ud(1) and ud.conf(5). - Add ldaprc (without ".") and ENVIRONMENT VARIABLES in ldap.conf(5). - Change manpage references to proper ".BR name (section)". Hallvard B. Furuseth <h.b.furuseth@usit.uio.no>, May 2002. 2002-05-09 10:07:41 +08:00			`.BR ldap_result (3),`
more updates 2006-06-14 08:19:32 +08:00			`.BR ldap_search_ext (3)`
merged with autoconf branch 1998-10-25 09:41:42 +08:00			`.SH ACKNOWLEDGEMENTS`
Tweaks to last commit 2006-06-14 07:07:10 +08:00			`.so ../Project`