<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="Function: ldap_delete - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: ldap_delete - Virtuoso Functions Guide" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href="functions.html" title="Chapter Contents" />
<link rel="prev" href="appendixa.html" title="Appendix" />
<link rel="next" href="functions.html#.html" title="" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>Function: ldap_delete - Virtuoso Functions Guide</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="fn_ldap_delete" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - ldap_delete</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_ldap_search.html" title="ldap_search">Prev</a> | <a class="link" href="fn_ldap_add.html" title="ldap_add">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a class="selected" href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
<div>
<a href="functions.html#admin">Administration</a>
</div>
<div>
<a href="functions.html#aggr">Aggregate Functions</a>
</div>
<div>
<a href="functions.html#array">Array Manipulation</a>
</div>
<div>
<a href="functions.html#bpel">BPEL APIs</a>
</div>
<div>
<a href="functions.html#backup">Backup</a>
</div>
<div>
<a href="functions.html#compression">Compression</a>
</div>
<div>
<a href="functions.html#cursors">Cursor</a>
</div>
<div>
<a href="functions.html#time">Date & Time Manipulation</a>
</div>
<div>
<a href="functions.html#debug">Debug</a>
</div>
<div>
<a href="functions.html#dict">Dictionary Manipulation</a>
</div>
<div>
<a href="functions.html#encoding">Encoding & Decoding</a>
</div>
<div>
<a href="functions.html#file">File Manipulation</a>
</div>
<div>
<a href="functions.html#ft">Free Text</a>
</div>
<div>
<a href="functions.html#hash">Hashing / Cryptographic</a>
</div>
<div>
<a class="selected" href="functions.html#ldap">LDAP</a>
</div>
<div class="selected">
<div>
<a href="fn_ldap_add.html">ldap_add</a>
</div>
<div>
<a class="selected" href="fn_ldap_delete.html">ldap_delete</a>
</div>
<div>
<a href="fn_ldap_modify.html">ldap_modify</a>
</div>
<div>
<a href="fn_ldap_search.html">ldap_search</a>
</div>
</div>
<div>
<a href="functions.html#localization">Locale</a>
</div>
<div>
<a href="functions.html#mail">Mail</a>
</div>
<div>
<a href="functions.html#misc">Miscellaneous</a>
</div>
<div>
<a href="functions.html#number">Number</a>
</div>
<div>
<a href="functions.html#phrz">Phrases</a>
</div>
<div>
<a href="functions.html#rdf">RDF data</a>
</div>
<div>
<a href="functions.html#rmt">Remote SQL Data Source</a>
</div>
<div>
<a href="functions.html#repl">Replication</a>
</div>
<div>
<a href="functions.html#soap">SOAP</a>
</div>
<div>
<a href="functions.html#sql">SQL</a>
</div>
<div>
<a href="functions.html#string">String</a>
</div>
<div>
<a href="functions.html#txn">Transaction</a>
</div>
<div>
<a href="functions.html#type">Type Mapping</a>
</div>
<div>
<a href="functions.html#uddi">UDDI</a>
</div>
<div>
<a href="functions.html#udt">User Defined Types & The CLR</a>
</div>
<div>
<a href="functions.html#vad">VAD</a>
</div>
<div>
<a href="functions.html#jvmpl">Virtuoso Java PL API</a>
</div>
<div>
<a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
</div>
<div>
<a href="functions.html#ws">Web & Internet</a>
</div>
<div>
<a href="functions.html#xml">XML</a>
</div>
<div>
<a href="functions.html#XPATH">XPATH & XQUERY</a>
</div>
<br />
<div>
<a href="functionidx.html">Functions Index</a>
</div>
<br />
</div>
<div id="text">
<h2>ldap_delete</h2>
<div class="refpurpose">Remove a leaf entry in the LDAP Directory Information Tree.</div>
<div class="funcsynopsis">
<span class="funcdef">int <span class="function">ldap_delete</span>
</span>
(<span class="paramdef">in <span class="parameter">server_url </span>varchar</span>,
<span class="paramdef">in <span class="parameter">try_tls </span>integer</span>,
<span class="paramdef">in <span class="parameter">entrydn </span>varchar</span>,
<span class="paramdef">in <span class="parameter">username </span>varchar</span>,
<span class="paramdef">in <span class="parameter">password </span>varchar</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>
This function removes a leaf entry in the LDAP Directory Information Tree.
</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">server_url – </span>
The server URL has three parts, <protocol>://<host>:<port>.
Missing parameters will be defaulted to <span class="computeroutput"><ldap://localhost:389></span>.</div>
<div class="refsect2">
<span class="refsect2title">try_tls – </span>
<span class="computeroutput">try_tls</span> is a flag that tells the client to perform a handshake
with the LDAP server using a secure connection. This is only applicable to the ldap:// protocol and not
ldaps://. If a secure connection cannot be made, the client will fall
back to using an insecure connection.</div>
<div class="refsect2">
<span class="refsect2title">entrydn – </span>
<span class="computeroutput">entrydn</span> is a qualified string which represents the LDAP DN entry to be deleted.</div>
<div class="refsect2">
<span class="refsect2title">username – </span>
username authorization credential</div>
<div class="refsect2">
<span class="refsect2title">password – </span>
password authorization credential</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>Zero for success or error code.</p>
</div>
<div class="refsect1title">Errors</div>
<table class="data">
<tr>
<th class="data">SQLState</th>
<th class="data">Error Code</th>
<th class="data">Error Text</th>
<th class="data">Description</th>
</tr>
<tr>
<td class="data">
<a name="err2E000" />
<span class="errorcode">2E000</span>
</td>
<td class="data">
<a name="errLD005" />
<span class="errorcode">LD005</span>
</td>
<td class="data">
<span class="errorname">Failed to initialize LDAP connection: <reason> (<reason code>)</span>
</td>
<td class="data" />
</tr>
<tr>
<td class="data">
<a name="err2E000" />
<span class="errorcode">2E000</span>
</td>
<td class="data">
<a name="errLD006" />
<span class="errorcode">LD006</span>
</td>
<td class="data">
<span class="errorname">Failed to set LDAP version option: <reason> (<reason code>)</span>
</td>
<td class="data" />
</tr>
<tr>
<td class="data">
<a name="err2E000" />
<span class="errorcode">2E000</span>
</td>
<td class="data">
<a name="errLD016" />
<span class="errorcode">LD016</span>
</td>
<td class="data">
<span class="errorname">Failed to start TLS: <reason> (<reason code>)</span>
</td>
<td class="data" />
</tr>
<tr>
<td class="data">
<a name="err28000" />
<span class="errorcode">28000</span>
</td>
<td class="data">
<a name="errLD007" />
<span class="errorcode">LD007</span>
</td>
<td class="data">
<span class="errorname">Failed to bind synchronous LDAP connection: <reason> (<reason code>)</span>
</td>
<td class="data" />
</tr>
<tr>
<td class="data">
<a name="err39000" />
<span class="errorcode">39000</span>
</td>
<td class="data">
<a name="errLD012" />
<span class="errorcode">LD012</span>
</td>
<td class="data">
<span class="errorname">Failed to delete the DN entry: <reason> (<reason code>)</span>
</td>
<td class="data" />
</tr>
<tr>
<td class="data">
<a name="err" />
<span class="errorcode" />
</td>
<td class="data">
<a name="err" />
<span class="errorcode" />
</td>
<td class="data">
<span class="errorname" />
</td>
<td class="data" />
</tr>
</table>
<br />
<p />
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_ldap_delete" />
<div class="example">
<div>
<pre class="programlisting">
if (not ldap_delete ('ldap://localhost', 0,
'cn=John Atanasov,mail=hellraisor@hotmail.com,c=US,o=hotmail.com', NULL))
{
-- the entry removed successfully, we can perform some other action
}
</pre>
</div>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div> <p>
<a href="fn_ldap_add.html">ldap_add()</a>, <a href="fn_ldap_modify.html">ldap_modify()</a>, <a href="fn_ldap_search.html">ldap_search()</a>
</p>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
375
