1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_ldap_delete">
<refmeta>
<refentrytitle>ldap_delete</refentrytitle>
<refmiscinfo>ldap</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ldap_delete</refname>
<refpurpose>Remove a leaf entry in the LDAP Directory Information Tree.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_ldap_delete">
<funcprototype id="fproto_ldap_delete">
<funcdef>int <function>ldap_delete</function></funcdef>
<paramdef>in <parameter>server_url </parameter>varchar</paramdef>
<paramdef>in <parameter>try_tls </parameter>integer</paramdef>
<paramdef>in <parameter>entrydn </parameter>varchar</paramdef>
<paramdef>in <parameter>username </parameter>varchar</paramdef>
<paramdef>in <parameter>password </parameter>varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_ldap_delete"><title>Description</title><para>
This function removes a leaf entry in the LDAP Directory Information Tree.
</para></refsect1>
<refsect1 id="params_ldap_delete"><title>Parameters</title>
<refsect2><title>server_url</title>
<para>The server URL has three parts, <protocol>://<host>:<port>.
Missing parameters will be defaulted to <programlisting><ldap://localhost:389></programlisting>.</para></refsect2>
<refsect2><title>try_tls</title>
<para><parameter>try_tls</parameter> 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.</para></refsect2>
<refsect2><title>entrydn</title>
<para><parameter>entrydn</parameter> is a qualified string which represents the LDAP DN entry to be deleted.</para></refsect2>
<refsect2><title>username</title>
<para>username authorization credential</para></refsect2>
<refsect2><title>password</title>
<para>password authorization credential</para></refsect2>
</refsect1>
<refsect1 id="ret_ldap_delete"><title>Return Types</title><para>Zero for success or error code.</para></refsect1>
<refsect1 id="errors_ldap_delete"><title>Errors</title>
<table><title>Errors signalled by <function>ldap_delete</function></title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode>2E000</errorcode></entry>
<entry><errorcode>LD005</errorcode></entry>
<entry><errorname>Failed to initialize LDAP connection: <reason> (<reason code>)</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>2E000</errorcode></entry>
<entry><errorcode>LD006</errorcode></entry>
<entry><errorname>Failed to set LDAP version option: <reason> (<reason code>)</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>2E000</errorcode></entry>
<entry><errorcode>LD016</errorcode></entry>
<entry><errorname>Failed to start TLS: <reason> (<reason code>)</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>28000</errorcode></entry>
<entry><errorcode>LD007</errorcode></entry>
<entry><errorname>Failed to bind synchronous LDAP connection: <reason> (<reason code>)</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>39000</errorcode></entry>
<entry><errorcode>LD012</errorcode></entry>
<entry><errorname>Failed to delete the DN entry: <reason> (<reason code>)</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode></errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname></errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples_ldap_delete"><title>Examples</title>
<example id="ex_ldap_delete">
<!-- <title>Using ldap_delete</title>
-->
<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
}
</programlisting>
</example>
</refsect1>
<refsect1 id="seealso_ldap_delete"><title>See Also</title> <para><link
linkend="fn_ldap_add"><function>ldap_add()</function></link>, <link
linkend="fn_ldap_modify"><function>ldap_modify()</function></link>, <link
linkend="fn_ldap_search"><function>ldap_search()</function></link></para>
</refsect1>
</refentry>
|
