162 lines
4.5 KiB
HTML
162 lines
4.5 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>ldap_abandon()--Abandon an LDAP Operation in Progress</title>
|
||
|
|
<!-- Begin Header Records ========================================== -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
||
|
|
<!-- This file has undergone html cleanup on 2/18/02 by JET -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
<h2>ldap_abandon()--Abandon an LDAP Operation in Progress</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <ldap.h>
|
||
|
|
|
||
|
|
int ldap_abandon(
|
||
|
|
LDAP <em>*ld</em>,
|
||
|
|
int <em>msgid</em>)
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>ldap_abandon()</strong> function is used to abandon or cancel an
|
||
|
|
LDAP operation in progress. The <strong><em>msgid</em></strong> passed should
|
||
|
|
be the message ID of an outstanding LDAP operation, as returned by a call to an
|
||
|
|
asynchronous LDAP operation such as <strong>ldap_search(),
|
||
|
|
ldap_modify(),</strong> and so on.</p>
|
||
|
|
|
||
|
|
<p>The <strong>ldap_abandon()</strong> APIs check to see if the result of the
|
||
|
|
operation has already been returned by the server. 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.</p>
|
||
|
|
|
||
|
|
<p>The caller can expect that the result of an abandoned operation will not be
|
||
|
|
returned from a future call to <strong>ldap_result()</strong>.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>No i5/OS authority is required.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong><em>ld</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) The LDAP pointer returned by a previous call to
|
||
|
|
<a href="ldap_init.htm">ldap_init()</a>,
|
||
|
|
<a href="ldap_ssl_init.htm">ldap_ssl_init()</a>, or
|
||
|
|
<a href="ldap_open.htm">ldap_open()</a>.<br><br></dd>
|
||
|
|
|
||
|
|
<dt><strong><em>msgid</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) The message ID of an outstanding LDAP operation, as returned by a
|
||
|
|
call to an asynchronous LDAP operation such as
|
||
|
|
<a href="ldap_search.htm">ldap_search()</a> or
|
||
|
|
<a href="ldap_modify.htm">ldap_modify()</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>LDAP_SUCCESS</strong></dt>
|
||
|
|
|
||
|
|
<dd>if the request was successful.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>-1</strong></dt>
|
||
|
|
|
||
|
|
<dd>if the request was not successful.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Error Conditions</h3>
|
||
|
|
|
||
|
|
<p>If <strong>ldap_abandon()</strong> is not successful, <strong><em>
|
||
|
|
ld_errno</em></strong> will be set to indicate the error. See
|
||
|
|
<a href="ldap_error_condt.htm">LDAP Client API Error Conditions</a> for possible LDAP
|
||
|
|
error codes values and <a href="ldap_get_errno.htm">ldap_get_errno()</a> function
|
||
|
|
to retrieve the error information.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<p>The following message may be sent from this function.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
||
|
|
<td align="left" valign="top">Error(s) occurred during running of ldap_abandon
|
||
|
|
API.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="ldap_abandon_ext.htm">ldap_abandon_ext()</a> -- Abandon (abort) an
|
||
|
|
asynchronous operation with controls.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V4R3
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"dirserv1.htm">LDAP APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|