| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
|
|---|
| 2 | <html>
|
|---|
| 3 | <head>
|
|---|
| 4 | <meta name="GENERATOR" content="PasDoc 0.9.0">
|
|---|
| 5 | <meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
|
|---|
| 6 | <title>ldapsend: Class TLDAPSend</title>
|
|---|
| 7 | <link rel="StyleSheet" type="text/css" href="pasdoc.css">
|
|---|
| 8 | </head>
|
|---|
| 9 | <body bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#800080" alink="#FF0000">
|
|---|
| 10 | <a name="TLDAPSend"></a><h1 class="cio">Class TLDAPSend</h1>
|
|---|
| 11 | <table class="sections">
|
|---|
| 12 | <tr>
|
|---|
| 13 | <td><a class="section" href="#@Description">Description</a></td><td><a class="section" href="#@Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#@Methods">Methods</a></td><td><a class="section" href="#@Properties">Properties</a></td></tr></table>
|
|---|
| 14 | <a name="@Description"></a><h2 class="unit">Unit</h2>
|
|---|
| 15 | <p class="unitlink">
|
|---|
| 16 | <a href="ldapsend.html">ldapsend</a></p>
|
|---|
| 17 | <h2 class="declaration">Declaration</h2>
|
|---|
| 18 | <p class="declaration">
|
|---|
| 19 | <code>type TLDAPSend = class(<a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>)</code></p>
|
|---|
| 20 | <h2 class="description">Description</h2>
|
|---|
| 21 | <p>
|
|---|
| 22 | Implementation of LDAP client</p>
|
|---|
| 23 | <p>
|
|---|
| 24 | (version 2 and 3)
|
|---|
| 25 |
|
|---|
| 26 | <p>Note: Are you missing properties for setting Username and Password? Look to parent <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a> object!
|
|---|
| 27 |
|
|---|
| 28 | <p>Are you missing properties for specify server address and port? Look to parent <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a> too!</p>
|
|---|
| 29 | <a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
|
|---|
| 30 | <ul class="hierarchy"><li class="ancestor">TObject</li>
|
|---|
| 31 | <li class="ancestor"><a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a></li>
|
|---|
| 32 | <li class="thisitem">TLDAPSend</li></ul><h2 class="overview">Overview</h2>
|
|---|
| 33 | <a name="@Methods"></a><h3 class="summary">Methods</h3>
|
|---|
| 34 | <table class="summary">
|
|---|
| 35 | <tr class="list">
|
|---|
| 36 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 37 | <td class="itemcode"><code>constructor <b><a href="ldapsend.TLDAPSend.html#Create">Create</a></b>;</code></td>
|
|---|
| 38 | </tr>
|
|---|
| 39 | <tr class="list2">
|
|---|
| 40 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 41 | <td class="itemcode"><code>destructor <b><a href="ldapsend.TLDAPSend.html#Destroy">Destroy</a></b>; override;</code></td>
|
|---|
| 42 | </tr>
|
|---|
| 43 | <tr class="list">
|
|---|
| 44 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 45 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Login">Login</a></b>: Boolean;</code></td>
|
|---|
| 46 | </tr>
|
|---|
| 47 | <tr class="list2">
|
|---|
| 48 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 49 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Bind">Bind</a></b>: Boolean;</code></td>
|
|---|
| 50 | </tr>
|
|---|
| 51 | <tr class="list">
|
|---|
| 52 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 53 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#BindSasl">BindSasl</a></b>: Boolean;</code></td>
|
|---|
| 54 | </tr>
|
|---|
| 55 | <tr class="list2">
|
|---|
| 56 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 57 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Logout">Logout</a></b>: Boolean;</code></td>
|
|---|
| 58 | </tr>
|
|---|
| 59 | <tr class="list">
|
|---|
| 60 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 61 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Modify">Modify</a></b>(obj: AnsiString; Op: <a href="ldapsend.html#TLDAPModifyOp">TLDAPModifyOp</a>; const Value: <a href="ldapsend.TLDAPAttribute.html">TLDAPAttribute</a>): Boolean;</code></td>
|
|---|
| 62 | </tr>
|
|---|
| 63 | <tr class="list2">
|
|---|
| 64 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 65 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Add">Add</a></b>(obj: AnsiString; const Value: <a href="ldapsend.TLDAPAttributeList.html">TLDAPAttributeList</a>): Boolean;</code></td>
|
|---|
| 66 | </tr>
|
|---|
| 67 | <tr class="list">
|
|---|
| 68 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 69 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Delete">Delete</a></b>(obj: AnsiString): Boolean;</code></td>
|
|---|
| 70 | </tr>
|
|---|
| 71 | <tr class="list2">
|
|---|
| 72 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 73 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#ModifyDN">ModifyDN</a></b>(obj, newRDN, newSuperior: AnsiString; DeleteoldRDN: Boolean): Boolean;</code></td>
|
|---|
| 74 | </tr>
|
|---|
| 75 | <tr class="list">
|
|---|
| 76 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 77 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Compare">Compare</a></b>(obj, AttributeValue: AnsiString): Boolean;</code></td>
|
|---|
| 78 | </tr>
|
|---|
| 79 | <tr class="list2">
|
|---|
| 80 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 81 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Search">Search</a></b>(obj: AnsiString; TypesOnly: Boolean; Filter: AnsiString; const Attributes: TStrings): Boolean;</code></td>
|
|---|
| 82 | </tr>
|
|---|
| 83 | <tr class="list">
|
|---|
| 84 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 85 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#Extended">Extended</a></b>(const Name, Value: AnsiString): Boolean;</code></td>
|
|---|
| 86 | </tr>
|
|---|
| 87 | <tr class="list2">
|
|---|
| 88 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 89 | <td class="itemcode"><code>function <b><a href="ldapsend.TLDAPSend.html#StartTLS">StartTLS</a></b>: Boolean;</code></td>
|
|---|
| 90 | </tr>
|
|---|
| 91 | </table>
|
|---|
| 92 | <a name="@Properties"></a><h3 class="summary">Properties</h3>
|
|---|
| 93 | <table class="summary">
|
|---|
| 94 | <tr class="list">
|
|---|
| 95 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 96 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#Version">Version</a></b>: integer read FVersion Write FVersion;</code></td>
|
|---|
| 97 | </tr>
|
|---|
| 98 | <tr class="list2">
|
|---|
| 99 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 100 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#ResultCode">ResultCode</a></b>: Integer read FResultCode;</code></td>
|
|---|
| 101 | </tr>
|
|---|
| 102 | <tr class="list">
|
|---|
| 103 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 104 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#ResultString">ResultString</a></b>: AnsiString read FResultString;</code></td>
|
|---|
| 105 | </tr>
|
|---|
| 106 | <tr class="list2">
|
|---|
| 107 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 108 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#FullResult">FullResult</a></b>: AnsiString read FFullResult;</code></td>
|
|---|
| 109 | </tr>
|
|---|
| 110 | <tr class="list">
|
|---|
| 111 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 112 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#AutoTLS">AutoTLS</a></b>: Boolean read FAutoTLS Write FAutoTLS;</code></td>
|
|---|
| 113 | </tr>
|
|---|
| 114 | <tr class="list2">
|
|---|
| 115 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 116 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#FullSSL">FullSSL</a></b>: Boolean read FFullSSL Write FFullSSL;</code></td>
|
|---|
| 117 | </tr>
|
|---|
| 118 | <tr class="list">
|
|---|
| 119 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 120 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#Seq">Seq</a></b>: integer read FSeq;</code></td>
|
|---|
| 121 | </tr>
|
|---|
| 122 | <tr class="list2">
|
|---|
| 123 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 124 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#SearchScope">SearchScope</a></b>: <a href="ldapsend.html#TLDAPSearchScope">TLDAPSearchScope</a> read FSearchScope Write FSearchScope;</code></td>
|
|---|
| 125 | </tr>
|
|---|
| 126 | <tr class="list">
|
|---|
| 127 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 128 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#SearchAliases">SearchAliases</a></b>: <a href="ldapsend.html#TLDAPSearchAliases">TLDAPSearchAliases</a> read FSearchAliases Write FSearchAliases;</code></td>
|
|---|
| 129 | </tr>
|
|---|
| 130 | <tr class="list2">
|
|---|
| 131 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 132 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#SearchSizeLimit">SearchSizeLimit</a></b>: integer read FSearchSizeLimit Write FSearchSizeLimit;</code></td>
|
|---|
| 133 | </tr>
|
|---|
| 134 | <tr class="list">
|
|---|
| 135 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 136 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#SearchTimeLimit">SearchTimeLimit</a></b>: integer read FSearchTimeLimit Write FSearchTimeLimit;</code></td>
|
|---|
| 137 | </tr>
|
|---|
| 138 | <tr class="list2">
|
|---|
| 139 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 140 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#SearchResult">SearchResult</a></b>: <a href="ldapsend.TLDAPResultList.html">TLDAPResultList</a> read FSearchResult;</code></td>
|
|---|
| 141 | </tr>
|
|---|
| 142 | <tr class="list">
|
|---|
| 143 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 144 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#Referals">Referals</a></b>: TStringList read FReferals;</code></td>
|
|---|
| 145 | </tr>
|
|---|
| 146 | <tr class="list2">
|
|---|
| 147 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 148 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#ExtName">ExtName</a></b>: AnsiString read FExtName;</code></td>
|
|---|
| 149 | </tr>
|
|---|
| 150 | <tr class="list">
|
|---|
| 151 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 152 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#ExtValue">ExtValue</a></b>: AnsiString read FExtValue;</code></td>
|
|---|
| 153 | </tr>
|
|---|
| 154 | <tr class="list2">
|
|---|
| 155 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 156 | <td class="itemcode"><code>property <b><a href="ldapsend.TLDAPSend.html#Sock">Sock</a></b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
|
|---|
| 157 | </tr>
|
|---|
| 158 | </table>
|
|---|
| 159 | <h2 class="description">Description</h2>
|
|---|
| 160 | <h3 class="detail">Methods</h3>
|
|---|
| 161 | <table class="detail">
|
|---|
| 162 | <tr class="list">
|
|---|
| 163 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 164 | <td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
|
|---|
| 165 | </tr>
|
|---|
| 166 | </table>
|
|---|
| 167 | <table class="detail">
|
|---|
| 168 | <tr class="list">
|
|---|
| 169 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 170 | <td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
|
|---|
| 171 | </tr>
|
|---|
| 172 | </table>
|
|---|
| 173 | <table class="detail">
|
|---|
| 174 | <tr class="list">
|
|---|
| 175 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 176 | <td class="itemcode"><a name="Login"></a><code>function <b>Login</b>: Boolean;</code></td>
|
|---|
| 177 | </tr>
|
|---|
| 178 | </table>
|
|---|
| 179 | <p>
|
|---|
| 180 | Try to connect to LDAP server and start secure channel, when it is required.</p>
|
|---|
| 181 | <table class="detail">
|
|---|
| 182 | <tr class="list">
|
|---|
| 183 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 184 | <td class="itemcode"><a name="Bind"></a><code>function <b>Bind</b>: Boolean;</code></td>
|
|---|
| 185 | </tr>
|
|---|
| 186 | </table>
|
|---|
| 187 | <p>
|
|---|
| 188 | Try to bind to LDAP server with <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>.<a class="normal" href="blcksock.TSynaClient.html#UserName">UserName</a> and <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>.<a class="normal" href="blcksock.TSynaClient.html#Password">Password</a>. If this is empty strings, then it do annonymous Bind. When you not call Bind on LDAPv3, then is automaticly used anonymous mode.
|
|---|
| 189 |
|
|---|
| 190 | <p>This method using plaintext transport of password! It is not secure!</p>
|
|---|
| 191 | <table class="detail">
|
|---|
| 192 | <tr class="list">
|
|---|
| 193 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 194 | <td class="itemcode"><a name="BindSasl"></a><code>function <b>BindSasl</b>: Boolean;</code></td>
|
|---|
| 195 | </tr>
|
|---|
| 196 | </table>
|
|---|
| 197 | <p>
|
|---|
| 198 | Try to bind to LDAP server with <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>.<a class="normal" href="blcksock.TSynaClient.html#UserName">UserName</a> and <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>.<a class="normal" href="blcksock.TSynaClient.html#Password">Password</a>. If this is empty strings, then it do annonymous Bind. When you not call Bind on LDAPv3, then is automaticly used anonymous mode.
|
|---|
| 199 |
|
|---|
| 200 | <p>This method using SASL with DIGEST-MD5 method for secure transfer of your password.</p>
|
|---|
| 201 | <table class="detail">
|
|---|
| 202 | <tr class="list">
|
|---|
| 203 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 204 | <td class="itemcode"><a name="Logout"></a><code>function <b>Logout</b>: Boolean;</code></td>
|
|---|
| 205 | </tr>
|
|---|
| 206 | </table>
|
|---|
| 207 | <p>
|
|---|
| 208 | Close connection to LDAP server.</p>
|
|---|
| 209 | <table class="detail">
|
|---|
| 210 | <tr class="list">
|
|---|
| 211 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 212 | <td class="itemcode"><a name="Modify"></a><code>function <b>Modify</b>(obj: AnsiString; Op: <a href="ldapsend.html#TLDAPModifyOp">TLDAPModifyOp</a>; const Value: <a href="ldapsend.TLDAPAttribute.html">TLDAPAttribute</a>): Boolean;</code></td>
|
|---|
| 213 | </tr>
|
|---|
| 214 | </table>
|
|---|
| 215 | <p>
|
|---|
| 216 | Modify content of LDAP attribute on this object.</p>
|
|---|
| 217 | <table class="detail">
|
|---|
| 218 | <tr class="list">
|
|---|
| 219 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 220 | <td class="itemcode"><a name="Add"></a><code>function <b>Add</b>(obj: AnsiString; const Value: <a href="ldapsend.TLDAPAttributeList.html">TLDAPAttributeList</a>): Boolean;</code></td>
|
|---|
| 221 | </tr>
|
|---|
| 222 | </table>
|
|---|
| 223 | <p>
|
|---|
| 224 | Add list of attributes to specified object.</p>
|
|---|
| 225 | <table class="detail">
|
|---|
| 226 | <tr class="list">
|
|---|
| 227 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 228 | <td class="itemcode"><a name="Delete"></a><code>function <b>Delete</b>(obj: AnsiString): Boolean;</code></td>
|
|---|
| 229 | </tr>
|
|---|
| 230 | </table>
|
|---|
| 231 | <p>
|
|---|
| 232 | Delete this LDAP object from server.</p>
|
|---|
| 233 | <table class="detail">
|
|---|
| 234 | <tr class="list">
|
|---|
| 235 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 236 | <td class="itemcode"><a name="ModifyDN"></a><code>function <b>ModifyDN</b>(obj, newRDN, newSuperior: AnsiString; DeleteoldRDN: Boolean): Boolean;</code></td>
|
|---|
| 237 | </tr>
|
|---|
| 238 | </table>
|
|---|
| 239 | <p>
|
|---|
| 240 | Modify object name of this LDAP object.</p>
|
|---|
| 241 | <table class="detail">
|
|---|
| 242 | <tr class="list">
|
|---|
| 243 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 244 | <td class="itemcode"><a name="Compare"></a><code>function <b>Compare</b>(obj, AttributeValue: AnsiString): Boolean;</code></td>
|
|---|
| 245 | </tr>
|
|---|
| 246 | </table>
|
|---|
| 247 | <p>
|
|---|
| 248 | Try to compare Attribute value with this LDAP object.</p>
|
|---|
| 249 | <table class="detail">
|
|---|
| 250 | <tr class="list">
|
|---|
| 251 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 252 | <td class="itemcode"><a name="Search"></a><code>function <b>Search</b>(obj: AnsiString; TypesOnly: Boolean; Filter: AnsiString; const Attributes: TStrings): Boolean;</code></td>
|
|---|
| 253 | </tr>
|
|---|
| 254 | </table>
|
|---|
| 255 | <p>
|
|---|
| 256 | Search LDAP base for LDAP objects by Filter.</p>
|
|---|
| 257 | <table class="detail">
|
|---|
| 258 | <tr class="list">
|
|---|
| 259 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 260 | <td class="itemcode"><a name="Extended"></a><code>function <b>Extended</b>(const Name, Value: AnsiString): Boolean;</code></td>
|
|---|
| 261 | </tr>
|
|---|
| 262 | </table>
|
|---|
| 263 | <p>
|
|---|
| 264 | Call any LDAPv3 extended command.</p>
|
|---|
| 265 | <table class="detail">
|
|---|
| 266 | <tr class="list">
|
|---|
| 267 | <td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|---|
| 268 | <td class="itemcode"><a name="StartTLS"></a><code>function <b>StartTLS</b>: Boolean;</code></td>
|
|---|
| 269 | </tr>
|
|---|
| 270 | </table>
|
|---|
| 271 | <p>
|
|---|
| 272 | Try to start SSL/TLS connection to LDAP server.</p>
|
|---|
| 273 | <h3 class="detail">Properties</h3>
|
|---|
| 274 | <table class="detail">
|
|---|
| 275 | <tr class="list">
|
|---|
| 276 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 277 | <td class="itemcode"><a name="Version"></a><code>property <b>Version</b>: integer read FVersion Write FVersion;</code></td>
|
|---|
| 278 | </tr>
|
|---|
| 279 | </table>
|
|---|
| 280 | <p>
|
|---|
| 281 | Specify version of used LDAP protocol. Default value is 3.</p>
|
|---|
| 282 | <table class="detail">
|
|---|
| 283 | <tr class="list">
|
|---|
| 284 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 285 | <td class="itemcode"><a name="ResultCode"></a><code>property <b>ResultCode</b>: Integer read FResultCode;</code></td>
|
|---|
| 286 | </tr>
|
|---|
| 287 | </table>
|
|---|
| 288 | <p>
|
|---|
| 289 | Result code of last LDAP operation.</p>
|
|---|
| 290 | <table class="detail">
|
|---|
| 291 | <tr class="list">
|
|---|
| 292 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 293 | <td class="itemcode"><a name="ResultString"></a><code>property <b>ResultString</b>: AnsiString read FResultString;</code></td>
|
|---|
| 294 | </tr>
|
|---|
| 295 | </table>
|
|---|
| 296 | <p>
|
|---|
| 297 | Human readable description of result code of last LDAP operation.</p>
|
|---|
| 298 | <table class="detail">
|
|---|
| 299 | <tr class="list">
|
|---|
| 300 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 301 | <td class="itemcode"><a name="FullResult"></a><code>property <b>FullResult</b>: AnsiString read FFullResult;</code></td>
|
|---|
| 302 | </tr>
|
|---|
| 303 | </table>
|
|---|
| 304 | <p>
|
|---|
| 305 | Binary string with full last response of LDAP server. This string is encoded by ASN.1 BER encoding! You need this only for debugging.</p>
|
|---|
| 306 | <table class="detail">
|
|---|
| 307 | <tr class="list">
|
|---|
| 308 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 309 | <td class="itemcode"><a name="AutoTLS"></a><code>property <b>AutoTLS</b>: Boolean read FAutoTLS Write FAutoTLS;</code></td>
|
|---|
| 310 | </tr>
|
|---|
| 311 | </table>
|
|---|
| 312 | <p>
|
|---|
| 313 | If <code>True</code>, then try to start TSL mode in Login procedure.</p>
|
|---|
| 314 | <table class="detail">
|
|---|
| 315 | <tr class="list">
|
|---|
| 316 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 317 | <td class="itemcode"><a name="FullSSL"></a><code>property <b>FullSSL</b>: Boolean read FFullSSL Write FFullSSL;</code></td>
|
|---|
| 318 | </tr>
|
|---|
| 319 | </table>
|
|---|
| 320 | <p>
|
|---|
| 321 | If <code>True</code>, then use connection to LDAP server through SSL/TLS tunnel.</p>
|
|---|
| 322 | <table class="detail">
|
|---|
| 323 | <tr class="list">
|
|---|
| 324 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 325 | <td class="itemcode"><a name="Seq"></a><code>property <b>Seq</b>: integer read FSeq;</code></td>
|
|---|
| 326 | </tr>
|
|---|
| 327 | </table>
|
|---|
| 328 | <p>
|
|---|
| 329 | Sequence number of last LDAp command. It is incremented by any LDAP command.</p>
|
|---|
| 330 | <table class="detail">
|
|---|
| 331 | <tr class="list">
|
|---|
| 332 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 333 | <td class="itemcode"><a name="SearchScope"></a><code>property <b>SearchScope</b>: <a href="ldapsend.html#TLDAPSearchScope">TLDAPSearchScope</a> read FSearchScope Write FSearchScope;</code></td>
|
|---|
| 334 | </tr>
|
|---|
| 335 | </table>
|
|---|
| 336 | <p>
|
|---|
| 337 | Specify what search scope is used in search command.</p>
|
|---|
| 338 | <table class="detail">
|
|---|
| 339 | <tr class="list">
|
|---|
| 340 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 341 | <td class="itemcode"><a name="SearchAliases"></a><code>property <b>SearchAliases</b>: <a href="ldapsend.html#TLDAPSearchAliases">TLDAPSearchAliases</a> read FSearchAliases Write FSearchAliases;</code></td>
|
|---|
| 342 | </tr>
|
|---|
| 343 | </table>
|
|---|
| 344 | <p>
|
|---|
| 345 | Specify how to handle aliases in search command.</p>
|
|---|
| 346 | <table class="detail">
|
|---|
| 347 | <tr class="list">
|
|---|
| 348 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 349 | <td class="itemcode"><a name="SearchSizeLimit"></a><code>property <b>SearchSizeLimit</b>: integer read FSearchSizeLimit Write FSearchSizeLimit;</code></td>
|
|---|
| 350 | </tr>
|
|---|
| 351 | </table>
|
|---|
| 352 | <p>
|
|---|
| 353 | Specify result size limit in search command. Value 0 means without limit.</p>
|
|---|
| 354 | <table class="detail">
|
|---|
| 355 | <tr class="list">
|
|---|
| 356 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 357 | <td class="itemcode"><a name="SearchTimeLimit"></a><code>property <b>SearchTimeLimit</b>: integer read FSearchTimeLimit Write FSearchTimeLimit;</code></td>
|
|---|
| 358 | </tr>
|
|---|
| 359 | </table>
|
|---|
| 360 | <p>
|
|---|
| 361 | Specify search time limit in search command (seconds). Value 0 means without limit.</p>
|
|---|
| 362 | <table class="detail">
|
|---|
| 363 | <tr class="list">
|
|---|
| 364 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 365 | <td class="itemcode"><a name="SearchResult"></a><code>property <b>SearchResult</b>: <a href="ldapsend.TLDAPResultList.html">TLDAPResultList</a> read FSearchResult;</code></td>
|
|---|
| 366 | </tr>
|
|---|
| 367 | </table>
|
|---|
| 368 | <p>
|
|---|
| 369 | Here is result of search command.</p>
|
|---|
| 370 | <table class="detail">
|
|---|
| 371 | <tr class="list">
|
|---|
| 372 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 373 | <td class="itemcode"><a name="Referals"></a><code>property <b>Referals</b>: TStringList read FReferals;</code></td>
|
|---|
| 374 | </tr>
|
|---|
| 375 | </table>
|
|---|
| 376 | <p>
|
|---|
| 377 | On each LDAP operation can LDAP server return some referals URLs. Here is their list.</p>
|
|---|
| 378 | <table class="detail">
|
|---|
| 379 | <tr class="list">
|
|---|
| 380 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 381 | <td class="itemcode"><a name="ExtName"></a><code>property <b>ExtName</b>: AnsiString read FExtName;</code></td>
|
|---|
| 382 | </tr>
|
|---|
| 383 | </table>
|
|---|
| 384 | <p>
|
|---|
| 385 | When you call <a class="normal" href="ldapsend.TLDAPSend.html#Extended">Extended</a> operation, then here is result Name returned by server.</p>
|
|---|
| 386 | <table class="detail">
|
|---|
| 387 | <tr class="list">
|
|---|
| 388 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 389 | <td class="itemcode"><a name="ExtValue"></a><code>property <b>ExtValue</b>: AnsiString read FExtValue;</code></td>
|
|---|
| 390 | </tr>
|
|---|
| 391 | </table>
|
|---|
| 392 | <p>
|
|---|
| 393 | When you call <a class="normal" href="ldapsend.TLDAPSend.html#Extended">Extended</a> operation, then here is result Value returned by server.</p>
|
|---|
| 394 | <table class="detail">
|
|---|
| 395 | <tr class="list">
|
|---|
| 396 | <td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
|
|---|
| 397 | <td class="itemcode"><a name="Sock"></a><code>property <b>Sock</b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
|
|---|
| 398 | </tr>
|
|---|
| 399 | </table>
|
|---|
| 400 | <p>
|
|---|
| 401 | TCP socket used by all LDAP operations.</p>
|
|---|
| 402 | <hr noshade size="1"><span class="appinfo"><em>Generated by <a target="_parent" href="http://pasdoc.sourceforge.net/">PasDoc 0.9.0</a> on 2012-04-23 21:38:51</em>
|
|---|
| 403 | </span>
|
|---|
| 404 | </body></html>
|
|---|