mirror of
https://git.openldap.org/openldap/openldap.git
synced 2024-12-21 03:10:25 +08:00
51 lines
1.4 KiB
Groff
51 lines
1.4 KiB
Groff
.TH LDAP_ABANDON 3 "22 September 1998" "OpenLDAP LDVERSION"
|
|
.\" $OpenLDAP$
|
|
.\" Copyright 1998-1999 The OpenLDAP Foundation All Rights Reserved.
|
|
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
|
|
.SH NAME
|
|
ldap_abandon \- Abandon an LDAP operation in progress
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.ft B
|
|
#include <lber.h>
|
|
#include <ldap.h>
|
|
.LP
|
|
.ft B
|
|
int ldap_abandon(ld, msgid)
|
|
.ft
|
|
LDAP *ld;
|
|
int msgid;
|
|
.SH DESCRIPTION
|
|
The
|
|
.B ldap_abandon()
|
|
routine is used to abandon or cancel an LDAP
|
|
operation in progress. The \fImsgid\fP passed should be the
|
|
message id of an outstanding LDAP operation, as returned by
|
|
.BR ldap_search (3),
|
|
.BR ldap_modify (3),
|
|
etc.
|
|
.LP
|
|
.BR 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.
|
|
.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).
|
|
.SH ERRORS
|
|
.B ldap_abandon()
|
|
returns 0 if everything goes ok, -1 otherwise,
|
|
setting \fIld_errno\fP appropriately. See
|
|
.BR ldap_error (3)
|
|
for details.
|
|
.SH SEE ALSO
|
|
.BR ldap(3),
|
|
.BR ldap_result(3),
|
|
.B ldap_error(3)
|
|
.SH ACKNOWLEDGEMENTS
|
|
.B OpenLDAP
|
|
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
|
|
.B OpenLDAP
|
|
is derived from University of Michigan LDAP 3.3 Release.
|