192 lines
5.4 KiB
HTML
192 lines
5.4 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_delete_ext()--Perform an LDAP Delete Operation with
|
|
Controls</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 -->
|
|
<!-- File Edited March 2001 -->
|
|
<!-- 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2>ldap_delete_ext()--Perform an LDAP Delete Operation with Controls</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <ldap.h>
|
|
|
|
int ldap_delete_ext(LDAP *<em>ld</em>,
|
|
const char *<em>dn</em>,
|
|
LDAPControl **<em>serverctrls</em>,
|
|
LDAPControl **<em>clientctrls</em>,
|
|
int *<em>msgidp</em>)
|
|
</pre>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>ldap_delete_ext()</strong> routine initiates an asynchronous
|
|
LDAP operation to delete a leaf entry with controls.</p>
|
|
|
|
<p>Note that the entry to delete must be a leaf entry (that is, it must have no
|
|
children). Deletion of entire subtrees in a single operation is not supported
|
|
by LDAP.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>No i5/OS authority is required. All authority checking is done by the LDAP
|
|
server.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
|
|
<dl>
|
|
<dt><em>ld</em></dt>
|
|
|
|
<dd>(Input) Specifies 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>.</dd>
|
|
|
|
<dt><em>dn</em></dt>
|
|
|
|
<dd>(Input) Specifies the Distinguished Name (DN) of the entry to be
|
|
deleted.</dd>
|
|
|
|
<dt><em>serverctrls</em></dt>
|
|
|
|
<dd>(Input) Specifies a list of LDAP server controls. This parameter may be set
|
|
to null. See <a href="ldap_controls.htm">LDAP Controls</a> for more information
|
|
about server controls.</dd>
|
|
|
|
<dt><em>clientctrls</em></dt>
|
|
|
|
<dd>(Input) Specifies a list of LDAP client controls. This parameter may be set
|
|
to null. See <a href="ldap_controls.htm">LDAP Controls</a> for more information
|
|
about client controls.</dd>
|
|
|
|
<dt><em>msgidp</em></dt>
|
|
|
|
<dd>(Output) This result parameter is set to the message id of the request if
|
|
the <strong>ldap_delete_ext()</strong> call succeeds.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>LDAP_SUCCESS</strong></dt>
|
|
|
|
<dd>if the request was successfully sent, <strong>ldap_delete_ext()</strong>
|
|
places the message id of the request in *<em>msgidp</em>. A subsequent call to
|
|
<a href="ldap_result.htm">ldap_result()</a> can be used to obtain the result of
|
|
the operation. Once the operation has completed, <a href="ldap_result.htm">
|
|
ldap_result()</a> returns a result that contains the status of the operation
|
|
(in the form of an error code). The error code indicates if the operation
|
|
completed successfully.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>another LDAP error code</strong></dt>
|
|
|
|
<dd>if the request was not successfully.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>The <strong>ldap_delete_ext()</strong> API will return an LDAP error code if
|
|
not successful. See <a href="ldap_error_condt.htm">LDAP Client API Error
|
|
Conditions</a> for possible LDAP error code values.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<p>The following message may be sent from this function.</p>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3CF2 E</td>
|
|
<td width="85%" valign="top">Error(s) occurred during running of
|
|
ldap_delete_ext API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li><a href="ldap_delete.htm">ldap_delete()</a> -- Asynchronous delete an
|
|
entry.</li>
|
|
|
|
<li><a href="ldap_delete_s.htm">ldap_delete_s()</a> -- Synchronous delete an
|
|
entry.</li>
|
|
|
|
<li><a href="ldap_delete_ext_s.htm">ldap_delete_ext_s()</a> -- Synchronous
|
|
delete an entry with controls.</li>
|
|
</ul>
|
|
|
|
<p>The <strong>ldap_delete_ext()</strong> API supports LDAP V3 server controls
|
|
and client controls.</p>
|
|
|
|
<hr>
|
|
API introduced: V4R5
|
|
|
|
<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>
|
|
|