usr/src/man/man3ldap/ldap_abandon.3ldap

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH LDAP_ABANDON 3LDAP "April 9, 2016"
   8 .SH NAME
   9 ldap_abandon \- abandon an LDAP operation in progress
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc[ \fIflag\fR... ] \fIfile\fR... -lldap[ \fIlibrary\fR... ]
  14 #include <lber.h>
  15 #include <ldap.h>
  16
  17 \fBint\fR \fBldap_abandon\fR(\fBLDAP\fR \fI*ld\fR, \fBint\fR \fImsgid\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .LP
  22 The \fBldap_abandon()\fR function is used to abandon or cancel an LDAP
  23 operation in progress.  The \fImsgid\fR passed should be the message id of an
  24 outstanding LDAP operation, as returned by \fBldap_search\fR(3LDAP),
  25 \fBldap_modify\fR(3LDAP), etc.
  26 .sp
  27 .LP
  28 \fBldap_abandon\fR(\|) checks to see if the result of the operation has already
  29 come in.  If it has, it deletes it from the queue of pending messages.  If not,
  30 it sends an LDAP abandon operation to the LDAP server.
  31 .sp
  32 .LP
  33 The caller can expect that the result of an abandoned operation will not be
  34 returned from a future call to \fBldap_result\fR(3LDAP).
  35 .SH ERRORS
  36 .LP
  37 \fBldap_abandon()\fR returns  \fB0\fR if successful or \fB\(mi1\fRotherwise and
  38 setting \fIld_errno\fR appropriately. See \fBldap_error\fR(3LDAP) for details.
  39 .SH ATTRIBUTES
  40 .LP
  41 See \fBattributes\fR(5) for a description of the following attributes:
  42 .sp
  43
  44 .sp
  45 .TS
  46 box;
  47 c | c
  48 l | l .
  49 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  50 Interface Stability     Evolving
  51 .TE
  52
  53 .SH SEE ALSO
  54 .LP
  55 \fBldap\fR(3LDAP), \fBldap_result\fR(3LDAP), \fBldap_error\fR(3LDAP),
  56 \fBattributes\fR(5)