<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KLDAP::LdapConnection Class Reference</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>KLDAP Library</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>KLDAP</b></li><li class="navelem"><a class="el" href="classKLDAP_1_1LdapConnection.html">LdapConnection</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classKLDAP_1_1LdapConnection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KLDAP::LdapConnection Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="ldapconnection_8h_source.html">ldapconnection.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a05fd019bb056ac49b28372fdcf0e780a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>SASL_Fields</b> { <b>SASL_Authname</b> = 0x1,
<b>SASL_Authzid</b> = 0x2,
<b>SASL_Realm</b> = 0x4,
<b>SASL_Password</b> = 0x8
}</td></tr>
<tr class="separator:a05fd019bb056ac49b28372fdcf0e780a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a311527db103d208ea990e8cd4749ab9b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a311527db103d208ea990e8cd4749ab9b">LdapConnection</a> ()</td></tr>
<tr class="separator:a311527db103d208ea990e8cd4749ab9b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3aab3b87ef05b27255cc687a5cc5fb11"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a3aab3b87ef05b27255cc687a5cc5fb11">LdapConnection</a> (const <a class="el" href="classKLDAP_1_1LdapUrl.html">LdapUrl</a> &url)</td></tr>
<tr class="separator:a3aab3b87ef05b27255cc687a5cc5fb11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2e03218906bcf3dc63a1b77429783a9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#ae2e03218906bcf3dc63a1b77429783a9">LdapConnection</a> (const <a class="el" href="classKLDAP_1_1LdapServer.html">LdapServer</a> &<a class="el" href="classKLDAP_1_1LdapConnection.html#a50b91b4bdc06c7e156f5d308353ecedd">server</a>)</td></tr>
<tr class="separator:ae2e03218906bcf3dc63a1b77429783a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a30557459bbbb7252d06ccf8783e191"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a8a30557459bbbb7252d06ccf8783e191">close</a> ()</td></tr>
<tr class="separator:a8a30557459bbbb7252d06ccf8783e191"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f22379df2759ebbd43d36ad76aca48a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a2f22379df2759ebbd43d36ad76aca48a">connect</a> ()</td></tr>
<tr class="separator:a2f22379df2759ebbd43d36ad76aca48a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a138073991eb68e9c6a45a307ef62423d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a138073991eb68e9c6a45a307ef62423d">connectionError</a> () const </td></tr>
<tr class="separator:a138073991eb68e9c6a45a307ef62423d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafbbae4929260cf17252eb46524a2c6e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#aafbbae4929260cf17252eb46524a2c6e">getOption</a> (int option, void *value) const </td></tr>
<tr class="separator:aafbbae4929260cf17252eb46524a2c6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa6c8ecf0e9a2c201ce999995765764e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#aaa6c8ecf0e9a2c201ce999995765764e">handle</a> () const </td></tr>
<tr class="separator:aaa6c8ecf0e9a2c201ce999995765764e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ecd8e68a3f0ddd75e8015601869d7fd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a0ecd8e68a3f0ddd75e8015601869d7fd">ldapErrorCode</a> () const </td></tr>
<tr class="separator:a0ecd8e68a3f0ddd75e8015601869d7fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af48a173f25cea1b144403f2fcf1a706a"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#af48a173f25cea1b144403f2fcf1a706a">ldapErrorString</a> () const </td></tr>
<tr class="separator:af48a173f25cea1b144403f2fcf1a706a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57b7f54e59e9a5a17e1c91104e49ed4a"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a57b7f54e59e9a5a17e1c91104e49ed4a">saslErrorString</a> () const </td></tr>
<tr class="separator:a57b7f54e59e9a5a17e1c91104e49ed4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4caaee9cd50a861260058885699c0fa6"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a4caaee9cd50a861260058885699c0fa6">saslHandle</a> () const </td></tr>
<tr class="separator:a4caaee9cd50a861260058885699c0fa6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50b91b4bdc06c7e156f5d308353ecedd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classKLDAP_1_1LdapServer.html">LdapServer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a50b91b4bdc06c7e156f5d308353ecedd">server</a> () const </td></tr>
<tr class="separator:a50b91b4bdc06c7e156f5d308353ecedd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7efd1ab26ffdc8b623f9e8fe16ee6440"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a7efd1ab26ffdc8b623f9e8fe16ee6440">setOption</a> (int option, void *value)</td></tr>
<tr class="separator:a7efd1ab26ffdc8b623f9e8fe16ee6440"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95c3207af9931f73f29375136bbd196c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a95c3207af9931f73f29375136bbd196c">setServer</a> (const <a class="el" href="classKLDAP_1_1LdapServer.html">LdapServer</a> &<a class="el" href="classKLDAP_1_1LdapConnection.html#a50b91b4bdc06c7e156f5d308353ecedd">server</a>)</td></tr>
<tr class="separator:a95c3207af9931f73f29375136bbd196c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8ad3d8c5be4f83b7962f1549de08544"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#ae8ad3d8c5be4f83b7962f1549de08544">setSizeLimit</a> (int sizelimit)</td></tr>
<tr class="separator:ae8ad3d8c5be4f83b7962f1549de08544"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8daed431e7aa60bc7aad37cf69ebc258"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a8daed431e7aa60bc7aad37cf69ebc258">setTimeLimit</a> (int timelimit)</td></tr>
<tr class="separator:a8daed431e7aa60bc7aad37cf69ebc258"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7250c45d7f6093ee714c2221cb34ba21"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a7250c45d7f6093ee714c2221cb34ba21">setUrl</a> (const <a class="el" href="classKLDAP_1_1LdapUrl.html">LdapUrl</a> &url)</td></tr>
<tr class="separator:a7250c45d7f6093ee714c2221cb34ba21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69d2f308981f01b702f1f7a9a1ec3de2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a69d2f308981f01b702f1f7a9a1ec3de2">sizeLimit</a> () const </td></tr>
<tr class="separator:a69d2f308981f01b702f1f7a9a1ec3de2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39a45bf454ec24b5bc513e8b6faace1b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#a39a45bf454ec24b5bc513e8b6faace1b">timeLimit</a> () const </td></tr>
<tr class="separator:a39a45bf454ec24b5bc513e8b6faace1b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad33a1e537d6ce2a311ec718c2e4ec201"><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKLDAP_1_1LdapConnection.html#ad33a1e537d6ce2a311ec718c2e4ec201">errorString</a> (int code)</td></tr>
<tr class="separator:ad33a1e537d6ce2a311ec718c2e4ec201"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class represents a connection to an LDAP server. </p>
<p>Definition at line <a class="el" href="ldapconnection_8h_source.html#l00036">36</a> of file <a class="el" href="ldapconnection_8h_source.html">ldapconnection.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a311527db103d208ea990e8cd4749ab9b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LdapConnection::LdapConnection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an <a class="el" href="classKLDAP_1_1LdapConnection.html" title="This class represents a connection to an LDAP server.">LdapConnection</a> object. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00092">92</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3aab3b87ef05b27255cc687a5cc5fb11"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LdapConnection::LdapConnection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKLDAP_1_1LdapUrl.html">LdapUrl</a> & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an <a class="el" href="classKLDAP_1_1LdapConnection.html" title="This class represents a connection to an LDAP server.">LdapConnection</a> with the parameters given in url. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00098">98</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae2e03218906bcf3dc63a1b77429783a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LdapConnection::LdapConnection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKLDAP_1_1LdapServer.html">LdapServer</a> & </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an <a class="el" href="classKLDAP_1_1LdapConnection.html" title="This class represents a connection to an LDAP server.">LdapConnection</a> with the parameters given in server. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00105">105</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8a30557459bbbb7252d06ccf8783e191"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LdapConnection::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes the LDAP connection. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00431">431</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2f22379df2759ebbd43d36ad76aca48a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LdapConnection::connect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up the connection parameters with creating a handle to the LDAP server. </p>
<p>Also sets sizelimit and timelimit and starts TLS if it is requested. Returns 0 if successful, else returns an LDAP error code, and an error string which is available via <a class="el" href="classKLDAP_1_1LdapConnection.html#a138073991eb68e9c6a45a307ef62423d" title="Returns a translated error string if connect() failed.">connectionError()</a>. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00421">421</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a138073991eb68e9c6a45a307ef62423d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString LdapConnection::connectionError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a translated error string if <a class="el" href="classKLDAP_1_1LdapConnection.html#a2f22379df2759ebbd43d36ad76aca48a" title="Sets up the connection parameters with creating a handle to the LDAP server.">connect()</a> failed. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00172">172</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad33a1e537d6ce2a311ec718c2e4ec201"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString LdapConnection::errorString </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>code</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a translated error message from the specified LDAP error code. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00143">143</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aafbbae4929260cf17252eb46524a2c6e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LdapConnection::getOption </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an option from the connection. </p>
<p>The option value can be client library specific, so avoid this function if possible </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00373">373</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaa6c8ecf0e9a2c201ce999995765764e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * LdapConnection::handle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the opaqe client-library specific LDAP object. </p>
<p>Avoid its usage if you can. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00133">133</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0ecd8e68a3f0ddd75e8015601869d7fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LdapConnection::ldapErrorCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the LDAP error code from the last operation. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00385">385</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af48a173f25cea1b144403f2fcf1a706a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString LdapConnection::ldapErrorString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the LDAP error string from the last operation. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00391">391</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a57b7f54e59e9a5a17e1c91104e49ed4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString LdapConnection::saslErrorString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the SASL error string from the last SASL operation. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00159">159</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4caaee9cd50a861260058885699c0fa6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * LdapConnection::saslHandle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the opaqe sasl-library specific SASL object. </p>
<p>Avoid its usage if you can. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00138">138</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a50b91b4bdc06c7e156f5d308353ecedd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classKLDAP_1_1LdapServer.html">LdapServer</a> & LdapConnection::server </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the connection parameters which was specified with an LDAP Url or a <a class="el" href="classKLDAP_1_1LdapServer.html" title="A class that contains LDAP server connection settings.">LdapServer</a> structure. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00128">128</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7efd1ab26ffdc8b623f9e8fe16ee6440"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LdapConnection::setOption </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets an option in the connection. </p>
<p>The option value can be client library specific, so avoid this function if possible </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00379">379</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a95c3207af9931f73f29375136bbd196c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LdapConnection::setServer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKLDAP_1_1LdapServer.html">LdapServer</a> & </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the connection parameters via the specified server structure. </p>
<p>After this, you need to call <a class="el" href="classKLDAP_1_1LdapConnection.html#a2f22379df2759ebbd43d36ad76aca48a" title="Sets up the connection parameters with creating a handle to the LDAP server.">connect()</a> to connect with the new parameters. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00123">123</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae8ad3d8c5be4f83b7962f1549de08544"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool LdapConnection::setSizeLimit </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>sizelimit</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the size limit for the connection. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00397">397</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8daed431e7aa60bc7aad37cf69ebc258"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool LdapConnection::setTimeLimit </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timelimit</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the time limit for the connection. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00409">409</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7250c45d7f6093ee714c2221cb34ba21"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LdapConnection::setUrl </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKLDAP_1_1LdapUrl.html">LdapUrl</a> & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the connection parameters via the specified url. </p>
<p>After this, you need to call <a class="el" href="classKLDAP_1_1LdapConnection.html#a2f22379df2759ebbd43d36ad76aca48a" title="Sets up the connection parameters with creating a handle to the LDAP server.">connect()</a> to connect with the new parameters. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00118">118</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a69d2f308981f01b702f1f7a9a1ec3de2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LdapConnection::sizeLimit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current size limit. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00403">403</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a39a45bf454ec24b5bc513e8b6faace1b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LdapConnection::timeLimit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current time limit. </p>
<p>Definition at line <a class="el" href="ldapconnection_8cpp_source.html#l00415">415</a> of file <a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ldapconnection_8h_source.html">ldapconnection.h</a></li>
<li><a class="el" href="ldapconnection_8cpp_source.html">ldapconnection.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:48:51 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">KLDAP Library</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "KLDAP Library"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKLDAP_1_1Ber.html">kldap::ber</option>, <option value="classKLDAP_1_1LdapConfigWidget.html">kldap::ldapconfigwidget</option>, <option value="classKLDAP_1_1LdapConnection.html">kldap::ldapconnection</option>, <option value="classKLDAP_1_1LdapControl.html">kldap::ldapcontrol</option>, <option value="classKLDAP_1_1LdapModel.html">kldap::ldapmodel</option>, <option value="classKLDAP_1_1LdapModel_1_1LdapModelPrivate.html">kldap::ldapmodel::ldapmodelprivate</option>, <option value="classKLDAP_1_1LdapModelAttrNode.html">kldap::ldapmodelattrnode</option>, <option value="classKLDAP_1_1LdapModelDNNode.html">kldap::ldapmodeldnnode</option>, <option value="classKLDAP_1_1LdapModelNode.html">kldap::ldapmodelnode</option>, <option value="classKLDAP_1_1LdapObject.html">kldap::ldapobject</option>, <option value="classKLDAP_1_1LdapOperation.html">kldap::ldapoperation</option>, <option value="classKLDAP_1_1LdapSearch.html">kldap::ldapsearch</option>, <option value="classKLDAP_1_1LdapServer.html">kldap::ldapserver</option>, <option value="classKLDAP_1_1LdapUrl.html">kldap::ldapurl</option>, <option value="classKLDAP_1_1Ldif.html">kldap::ldif</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
