<!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()--Perform an LDAP Delete Operation</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()--Perform an LDAP Delete Operation</h2> <div class="box" style="width: 70%;"> <br> Syntax<br> <pre> #include <ldap.h> int ldap_delete( LDAP *<em>ld</em>, const char *<em>dn</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()</strong> routine initiates an asynchronous LDAP operation to delete a leaf entry. The result of the operation can be obtained by a subsequent call to <a href="ldap_result.htm">ldap_result()</a>.</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 DN of the entry to be deleted.</dd> </dl> <br> <h3>Return Value</h3> <dl> <dt><strong>Message ID of the Operation Initiated</strong></dt> <dd>If the request was successful. </dd> <dt><strong>-1</strong></dt> <dd>If the request was not successful.</dd> </dl> <br> <h3>Error Conditions</h3> <p>If <strong>ldap_delete()</strong> is not successful, <em>ld_errno</em> will be set to indicate the error. See <a href="ldap_error_condt.htm">LDAP Client API Error Conditions</a> for possible LDAP error code values. Use <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 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 API.</td> </tr> </table> <br> <br> <h3>Related Information</h3> <ul><li><a href= "ldap_delete_s.htm">ldap_delete_s()</a> -- Synchronous delete an entry.</li> <li><a href= "ldap_delete_ext.htm">ldap_delete_ext()</a> -- Asynchronous delete an entry with controls.</li> <li><a href= "ldap_delete_ext_s.htm">ldap_delete_ext_s()</a> -- Synchronous delete an entry with controls.</li> </ul> <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>