apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bo...@apache.org
Subject svn commit: r784636 [12/47] - in /apr/site/trunk/docs/docs: apr-util/trunk/ apr/trunk/
Date Mon, 15 Jun 2009 00:01:47 GMT
Added: apr/site/trunk/docs/docs/apr/trunk/apr__ldap_8h-source.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__ldap_8h-source.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__ldap_8h-source.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__ldap_8h-source.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,228 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_ldap.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li><a href="examples.html"><span>Examples</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+      <li><a href="globals.html"><span>Globals</span></a></li>
+    </ul>
+  </div>
+<h1>apr_ldap.h</h1><a href="apr__ldap_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
+<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements.  See the NOTICE file distributed with</span>
+<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
+<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
+<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
+<a name="l00006"></a>00006 <span class="comment"> * the License.  You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment"> *</span>
+<a name="l00008"></a>00008 <span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment"> *</span>
+<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
+<a name="l00015"></a>00015 <span class="comment"> */</span>
+<a name="l00016"></a>00016 
+<a name="l00017"></a>00017 <span class="comment">/*</span>
+<a name="l00018"></a>00018 <span class="comment"> * apr_ldap.h is generated from apr_ldap.h.in by configure -- do not edit apr_ldap.h</span>
+<a name="l00019"></a>00019 <span class="comment"> */</span><span class="comment"></span>
+<a name="l00020"></a>00020 <span class="comment">/**</span>
+<a name="l00021"></a>00021 <span class="comment"> * @file apr_ldap.h</span>
+<a name="l00022"></a>00022 <span class="comment"> * @brief  APR-UTIL LDAP </span>
+<a name="l00023"></a>00023 <span class="comment"> */</span>
+<a name="l00024"></a>00024 <span class="preprocessor">#ifndef APU_LDAP_H</span>
+<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_H</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00027"></a>00027 <span class="comment">/**</span>
+<a name="l00028"></a>00028 <span class="comment"> * @defgroup APR_Util_LDAP LDAP</span>
+<a name="l00029"></a>00029 <span class="comment"> * @ingroup APR_Util</span>
+<a name="l00030"></a>00030 <span class="comment"> * @{</span>
+<a name="l00031"></a>00031 <span class="comment"> */</span>
+<a name="l00032"></a>00032 
+<a name="l00033"></a>00033 <span class="comment">/* this will be defined if LDAP support was compiled into apr-util */</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#define APR_HAS_LDAP              0</span>
+<a name="l00035"></a>00035 <span class="preprocessor"></span>
+<a name="l00036"></a>00036 <span class="comment">/* identify the LDAP toolkit used */</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#define APR_HAS_NETSCAPE_LDAPSDK  0</span>
+<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_SOLARIS_LDAPSDK   0</span>
+<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_NOVELL_LDAPSDK    0</span>
+<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_MOZILLA_LDAPSDK   0</span>
+<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_OPENLDAP_LDAPSDK  0</span>
+<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_MICROSOFT_LDAPSDK 0</span>
+<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_TIVOLI_LDAPSDK    0</span>
+<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_ZOS_LDAPSDK       0</span>
+<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_OTHER_LDAPSDK     0</span>
+<a name="l00046"></a>00046 <span class="preprocessor"></span>
+<a name="l00047"></a>00047 
+<a name="l00048"></a>00048 <span class="comment">/*</span>
+<a name="l00049"></a>00049 <span class="comment"> * Handle the case when LDAP is enabled</span>
+<a name="l00050"></a>00050 <span class="comment"> */</span>
+<a name="l00051"></a>00051 <span class="preprocessor">#if APR_HAS_LDAP</span>
+<a name="l00052"></a>00052 <span class="preprocessor"></span>
+<a name="l00053"></a>00053 <span class="comment">/*</span>
+<a name="l00054"></a>00054 <span class="comment"> * The following #defines are DEPRECATED and should not be used for</span>
+<a name="l00055"></a>00055 <span class="comment"> * anything. They remain to maintain binary compatibility.</span>
+<a name="l00056"></a>00056 <span class="comment"> * The original code defined the OPENLDAP SDK as present regardless</span>
+<a name="l00057"></a>00057 <span class="comment"> * of what really was there, which was way bogus. In addition, the</span>
+<a name="l00058"></a>00058 <span class="comment"> * apr_ldap_url_parse*() functions have been rewritten specifically for</span>
+<a name="l00059"></a>00059 <span class="comment"> * APR, so the APR_HAS_LDAP_URL_PARSE macro is forced to zero.</span>
+<a name="l00060"></a>00060 <span class="comment"> */</span>
+<a name="l00061"></a>00061 <span class="preprocessor">#if APR_HAS_TIVOLI_LDAPSDK</span>
+<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAP_SSL 0</span>
+<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAP_SSL 1</span>
+<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAP_URL_PARSE      0</span>
+<a name="l00067"></a>00067 <span class="preprocessor"></span>
+<a name="l00068"></a>00068 <span class="preprocessor">#if APR_HAS_OPENLDAP_LDAPSDK &amp;&amp; !defined(LDAP_DEPRECATED) </span>
+<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="comment">/* Ensure that the "deprecated" interfaces are still exposed</span>
+<a name="l00070"></a>00070 <span class="comment"> * with OpenLDAP &gt;= 2.3; these were exposed by default in earlier</span>
+<a name="l00071"></a>00071 <span class="comment"> * releases. */</span>
+<a name="l00072"></a>00072 <span class="preprocessor">#define LDAP_DEPRECATED 1</span>
+<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00074"></a>00074 <span class="preprocessor"></span>
+<a name="l00075"></a>00075 <span class="comment">/*</span>
+<a name="l00076"></a>00076 <span class="comment"> * Include the standard LDAP header files.</span>
+<a name="l00077"></a>00077 <span class="comment"> */</span>
+<a name="l00078"></a>00078 
+<a name="l00079"></a>00079 
+<a name="l00080"></a>00080 
+<a name="l00081"></a>00081 
+<a name="l00082"></a>00082 
+<a name="l00083"></a>00083 
+<a name="l00084"></a>00084 <span class="comment">/*</span>
+<a name="l00085"></a>00085 <span class="comment"> * Detected standard functions</span>
+<a name="l00086"></a>00086 <span class="comment"> */</span>
+<a name="l00087"></a>00087 <span class="preprocessor">#define APR_HAS_LDAPSSL_CLIENT_INIT 0</span>
+<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAPSSL_CLIENT_DEINIT 0</span>
+<a name="l00089"></a>00089 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAPSSL_ADD_TRUSTED_CERT 0</span>
+<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAP_START_TLS_S 0</span>
+<a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAP_SSLINIT 0</span>
+<a name="l00092"></a>00092 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAPSSL_INIT 0</span>
+<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="preprocessor">#define APR_HAS_LDAPSSL_INSTALL_ROUTINES 0</span>
+<a name="l00094"></a>00094 <span class="preprocessor"></span>
+<a name="l00095"></a>00095 <span class="comment">/*</span>
+<a name="l00096"></a>00096 <span class="comment"> * Make sure the secure LDAP port is defined</span>
+<a name="l00097"></a>00097 <span class="comment"> */</span>
+<a name="l00098"></a>00098 <span class="preprocessor">#ifndef LDAPS_PORT</span>
+<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor">#define LDAPS_PORT 636  </span><span class="comment">/* ldaps:/// default LDAP over TLS port */</span>
+<a name="l00100"></a>00100 <span class="preprocessor">#endif</span>
+<a name="l00101"></a>00101 <span class="preprocessor"></span>
+<a name="l00102"></a>00102 <span class="comment">/*</span>
+<a name="l00103"></a>00103 <span class="comment"> * For ldap function calls that input a size limit on the number of returned elements</span>
+<a name="l00104"></a>00104 <span class="comment"> * Some SDKs do not have the define for LDAP_DEFAULT_LIMIT (-1) or LDAP_NO_LIMIT (0)</span>
+<a name="l00105"></a>00105 <span class="comment"> * LDAP_DEFAULT_LIMIT is preferred as it allows inheritance from whatever the SDK</span>
+<a name="l00106"></a>00106 <span class="comment"> * or process is configured for.</span>
+<a name="l00107"></a>00107 <span class="comment"> */</span>
+<a name="l00108"></a>00108 <span class="preprocessor">#ifdef LDAP_DEFAULT_LIMIT</span>
+<a name="l00109"></a>00109 <span class="preprocessor"></span><span class="preprocessor">#define APR_LDAP_SIZELIMIT LDAP_DEFAULT_LIMIT</span>
+<a name="l00110"></a>00110 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00111"></a>00111 <span class="preprocessor"></span><span class="preprocessor">#ifdef LDAP_NO_LIMIT</span>
+<a name="l00112"></a>00112 <span class="preprocessor"></span><span class="preprocessor">#define APR_LDAP_SIZELIMIT LDAP_NO_LIMIT</span>
+<a name="l00113"></a>00113 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00114"></a>00114 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00115"></a>00115 <span class="preprocessor"></span>
+<a name="l00116"></a>00116 <span class="preprocessor">#ifndef APR_LDAP_SIZELIMIT</span>
+<a name="l00117"></a>00117 <span class="preprocessor"></span><span class="preprocessor">#define APR_LDAP_SIZELIMIT 0 </span><span class="comment">/* equivalent to LDAP_NO_LIMIT, and what goes on the wire */</span>
+<a name="l00118"></a>00118 <span class="preprocessor">#endif</span>
+<a name="l00119"></a>00119 <span class="preprocessor"></span>
+<a name="l00120"></a>00120 <span class="comment">/*</span>
+<a name="l00121"></a>00121 <span class="comment"> * z/OS is missing some defines</span>
+<a name="l00122"></a>00122 <span class="comment"> */</span>
+<a name="l00123"></a>00123 <span class="preprocessor">#ifndef LDAP_VERSION_MAX</span>
+<a name="l00124"></a>00124 <span class="preprocessor"></span><span class="preprocessor">#define LDAP_VERSION_MAX  LDAP_VERSION</span>
+<a name="l00125"></a>00125 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00126"></a>00126 <span class="preprocessor"></span><span class="preprocessor">#if APR_HAS_ZOS_LDAPSDK</span>
+<a name="l00127"></a>00127 <span class="preprocessor"></span><span class="preprocessor">#define LDAP_VENDOR_NAME "IBM z/OS"</span>
+<a name="l00128"></a>00128 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00129"></a>00129 <span class="preprocessor"></span>
+<a name="l00130"></a>00130 <span class="comment">/* Note: Macros defining const casting has been removed in APR v1.0,</span>
+<a name="l00131"></a>00131 <span class="comment"> * pending real support for LDAP v2.0 toolkits.</span>
+<a name="l00132"></a>00132 <span class="comment"> *</span>
+<a name="l00133"></a>00133 <span class="comment"> * In the mean time, please use an LDAP v3.0 toolkit.</span>
+<a name="l00134"></a>00134 <span class="comment"> */</span>
+<a name="l00135"></a>00135 <span class="preprocessor">#if LDAP_VERSION_MAX &lt;= 2</span>
+<a name="l00136"></a>00136 <span class="preprocessor"></span><span class="preprocessor">#error Support for LDAP v2.0 toolkits has been removed from apr-util. Please use an LDAP v3.0 toolkit.</span>
+<a name="l00137"></a>00137 <span class="preprocessor"></span><span class="preprocessor">#endif </span>
+<a name="l00138"></a>00138 <span class="preprocessor"></span>
+<a name="l00139"></a>00139 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00140"></a>00140 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00141"></a>00141 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
+<a name="l00142"></a>00142 <span class="comment"></span>
+<a name="l00143"></a>00143 <span class="comment">/**</span>
+<a name="l00144"></a>00144 <span class="comment"> * This structure allows the C LDAP API error codes to be returned</span>
+<a name="l00145"></a>00145 <span class="comment"> * along with plain text error messages that explain to us mere mortals</span>
+<a name="l00146"></a>00146 <span class="comment"> * what really happened.</span>
+<a name="l00147"></a>00147 <span class="comment"> */</span>
+<a name="l00148"></a>00148 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_ldap_err_t {
+<a name="l00149"></a>00149     <span class="keyword">const</span> <span class="keywordtype">char</span> *reason;
+<a name="l00150"></a>00150     <span class="keyword">const</span> <span class="keywordtype">char</span> *msg;
+<a name="l00151"></a>00151     <span class="keywordtype">int</span> rc;
+<a name="l00152"></a>00152 } apr_ldap_err_t;
+<a name="l00153"></a>00153 
+<a name="l00154"></a>00154 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00155"></a>00155 <span class="preprocessor"></span>}
+<a name="l00156"></a>00156 <span class="preprocessor">#endif</span>
+<a name="l00157"></a>00157 <span class="preprocessor"></span>
+<a name="l00158"></a>00158 <span class="comment">/* The MS SDK returns LDAP_UNAVAILABLE when the backend has closed the connection</span>
+<a name="l00159"></a>00159 <span class="comment"> * between LDAP calls. Protect with APR_HAS_MICROSOFT_LDAPSDK in case someone </span>
+<a name="l00160"></a>00160 <span class="comment"> * manually chooses another SDK on Windows </span>
+<a name="l00161"></a>00161 <span class="comment"> */</span>
+<a name="l00162"></a>00162 <span class="preprocessor">#if APR_HAS_MICROSOFT_LDAPSDK</span>
+<a name="l00163"></a>00163 <span class="preprocessor"></span><span class="preprocessor">#define APR_LDAP_IS_SERVER_DOWN(s)    ((s) == LDAP_SERVER_DOWN \</span>
+<a name="l00164"></a>00164 <span class="preprocessor">                                    || (s) == LDAP_UNAVAILABLE)</span>
+<a name="l00165"></a>00165 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00166"></a>00166 <span class="preprocessor"></span><span class="preprocessor">#define APR_LDAP_IS_SERVER_DOWN(s)    ((s) == LDAP_SERVER_DOWN)</span>
+<a name="l00167"></a>00167 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00168"></a>00168 <span class="preprocessor"></span>
+<a name="l00169"></a>00169 <span class="comment">/* These symbols are not actually exported in a DSO build, but mapped into</span>
+<a name="l00170"></a>00170 <span class="comment"> * a private exported function array for apr_ldap_stub to bind dynamically.</span>
+<a name="l00171"></a>00171 <span class="comment"> * Rename them appropriately to protect the global namespace.</span>
+<a name="l00172"></a>00172 <span class="comment"> */</span>
+<a name="l00173"></a>00173 <span class="preprocessor">#ifdef APU_DSO_LDAP_BUILD</span>
+<a name="l00174"></a>00174 <span class="preprocessor"></span>
+<a name="l00175"></a>00175 <span class="preprocessor">#define apr_ldap_info apr__ldap_info</span>
+<a name="l00176"></a>00176 <span class="preprocessor"></span><span class="preprocessor">#define apr_ldap_init apr__ldap_init</span>
+<a name="l00177"></a>00177 <span class="preprocessor"></span><span class="preprocessor">#define apr_ldap_ssl_init apr__ldap_ssl_init</span>
+<a name="l00178"></a>00178 <span class="preprocessor"></span><span class="preprocessor">#define apr_ldap_ssl_deinit apr__ldap_ssl_deinit</span>
+<a name="l00179"></a>00179 <span class="preprocessor"></span><span class="preprocessor">#define apr_ldap_get_option apr__ldap_get_option</span>
+<a name="l00180"></a>00180 <span class="preprocessor"></span><span class="preprocessor">#define apr_ldap_set_option apr__ldap_set_option</span>
+<a name="l00181"></a>00181 <span class="preprocessor"></span><span class="preprocessor">#define apr_ldap_rebind_init apr__ldap_rebind_init</span>
+<a name="l00182"></a>00182 <span class="preprocessor"></span><span class="preprocessor">#define apr_ldap_rebind_add apr__ldap_rebind_add</span>
+<a name="l00183"></a>00183 <span class="preprocessor"></span><span class="preprocessor">#define apr_ldap_rebind_remove apr__ldap_rebind_remove</span>
+<a name="l00184"></a>00184 <span class="preprocessor"></span>
+<a name="l00185"></a>00185 <span class="preprocessor">#define APU_DECLARE_LDAP(type) type</span>
+<a name="l00186"></a>00186 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00187"></a>00187 <span class="preprocessor"></span><span class="preprocessor">#define APU_DECLARE_LDAP(type) APU_DECLARE(type)</span>
+<a name="l00188"></a>00188 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00189"></a>00189 <span class="preprocessor"></span>
+<a name="l00190"></a>00190 <span class="preprocessor">#include "<a class="code" href="apr__ldap__url_8h.html" title="APR-UTIL LDAP ldap_init() functions.">apr_ldap_url.h</a>"</span>
+<a name="l00191"></a>00191 <span class="preprocessor">#include "<a class="code" href="apr__ldap__init_8h.html" title="APR-UTIL LDAP ldap_init() functions.">apr_ldap_init.h</a>"</span>
+<a name="l00192"></a>00192 <span class="preprocessor">#include "<a class="code" href="apr__ldap__option_8h.html" title="APR-UTIL LDAP ldap_*_option() functions.">apr_ldap_option.h</a>"</span>
+<a name="l00193"></a>00193 <span class="preprocessor">#include "<a class="code" href="apr__ldap__rebind_8h.html" title="Apache LDAP library.">apr_ldap_rebind.h</a>"</span>
+<a name="l00194"></a>00194 <span class="comment"></span>
+<a name="l00195"></a>00195 <span class="comment">/** @} */</span>
+<a name="l00196"></a>00196 <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_LDAP */</span>
+<a name="l00197"></a>00197 <span class="preprocessor">#endif </span><span class="comment">/* APU_LDAP_H */</span>
+</pre></div></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>

Added: apr/site/trunk/docs/docs/apr/trunk/apr__ldap_8h.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__ldap_8h.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__ldap_8h.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__ldap_8h.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,75 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_ldap.h File Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li><a href="examples.html"><span>Examples</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+      <li><a href="globals.html"><span>Globals</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>apr_ldap.h File Reference</h1>APR-UTIL LDAP.  
+<a href="#_details">More...</a>
+<p>
+
+<p>
+<a href="apr__ldap_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf8d199208a26c4ee4c6db46764675f01"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_LDAP" ref="gf8d199208a26c4ee4c6db46764675f01" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_LDAP</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5ee3703cda47ea3fa8bb82b94341742c"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_NETSCAPE_LDAPSDK" ref="g5ee3703cda47ea3fa8bb82b94341742c" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_NETSCAPE_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdfd79510be01b585d07d3a0cf517377a"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_SOLARIS_LDAPSDK" ref="gdfd79510be01b585d07d3a0cf517377a" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_SOLARIS_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g61438dcd7b6c386fab3b3da59c884f2c"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_NOVELL_LDAPSDK" ref="g61438dcd7b6c386fab3b3da59c884f2c" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_NOVELL_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6e9f26af3e9801f4f3dfb6ccb51ab4fe"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_MOZILLA_LDAPSDK" ref="g6e9f26af3e9801f4f3dfb6ccb51ab4fe" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_MOZILLA_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g53eb8a677574757eab3aeef411c79e82"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_OPENLDAP_LDAPSDK" ref="g53eb8a677574757eab3aeef411c79e82" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_OPENLDAP_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4d353111e4fc3f79a7a9a4d9a37b4099"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_MICROSOFT_LDAPSDK" ref="g4d353111e4fc3f79a7a9a4d9a37b4099" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_MICROSOFT_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd46b9586b73ac6e51a02831275f8b04e"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_TIVOLI_LDAPSDK" ref="gd46b9586b73ac6e51a02831275f8b04e" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_TIVOLI_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gaf7c4fb35087815ead3905b61df10791"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_ZOS_LDAPSDK" ref="gaf7c4fb35087815ead3905b61df10791" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_ZOS_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g23badc30790c00670f7d32485aef644f"></a><!-- doxytag: member="apr_ldap.h::APR_HAS_OTHER_LDAPSDK" ref="g23badc30790c00670f7d32485aef644f" args="" -->
+#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>APR_HAS_OTHER_LDAPSDK</b>&nbsp;&nbsp;&nbsp;0</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+APR-UTIL LDAP. 
+<p>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>

Added: apr/site/trunk/docs/docs/apr/trunk/apr__ldap__init_8h-source.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__ldap__init_8h-source.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__ldap__init_8h-source.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__ldap__init_8h-source.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,196 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_ldap_init.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li><a href="examples.html"><span>Examples</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+      <li><a href="globals.html"><span>Globals</span></a></li>
+    </ul>
+  </div>
+<h1>apr_ldap_init.h</h1><a href="apr__ldap__init_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
+<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements.  See the NOTICE file distributed with</span>
+<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
+<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
+<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
+<a name="l00006"></a>00006 <span class="comment"> * the License.  You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment"> *</span>
+<a name="l00008"></a>00008 <span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment"> *</span>
+<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
+<a name="l00015"></a>00015 <span class="comment"> */</span>
+<a name="l00016"></a>00016 <span class="comment"></span>
+<a name="l00017"></a>00017 <span class="comment">/**</span>
+<a name="l00018"></a>00018 <span class="comment"> * @file apr_ldap_init.h</span>
+<a name="l00019"></a>00019 <span class="comment"> * @brief  APR-UTIL LDAP ldap_init() functions</span>
+<a name="l00020"></a>00020 <span class="comment"> */</span>
+<a name="l00021"></a>00021 <span class="preprocessor">#ifndef APR_LDAP_INIT_H</span>
+<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define APR_LDAP_INIT_H</span>
+<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00024"></a>00024 <span class="comment">/**</span>
+<a name="l00025"></a>00025 <span class="comment"> * @addtogroup APR_Util_LDAP</span>
+<a name="l00026"></a>00026 <span class="comment"> * @{</span>
+<a name="l00027"></a>00027 <span class="comment"> */</span>
+<a name="l00028"></a>00028 
+<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="apr__ldap_8h.html" title="APR-UTIL LDAP.">apr_ldap.h</a>"</span>
+<a name="l00030"></a>00030 
+<a name="l00031"></a>00031 <span class="preprocessor">#if APR_HAS_LDAP</span>
+<a name="l00032"></a>00032 <span class="preprocessor"></span>
+<a name="l00033"></a>00033 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00035"></a>00035 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
+<a name="l00036"></a>00036 
+<a name="l00037"></a>00037 <span class="comment"></span>
+<a name="l00038"></a>00038 <span class="comment">/**</span>
+<a name="l00039"></a>00039 <span class="comment"> * Macro to detect security related return values.</span>
+<a name="l00040"></a>00040 <span class="comment"> */</span>
+<a name="l00041"></a>00041 <span class="preprocessor">#if defined(LDAP_INSUFFICIENT_ACCESS)</span>
+<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_ACCESS</span>
+<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#elif defined(LDAP_INSUFFICIENT_RIGHTS)</span>
+<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_RIGHTS</span>
+<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#elif defined(APR_HAS_MICROSOFT_LDAPSDK)</span>
+<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="comment">/* The macros above fail to contemplate that LDAP_RETCODE values</span>
+<a name="l00047"></a>00047 <span class="comment"> * may be represented by an enum.  autoconf tests would be much</span>
+<a name="l00048"></a>00048 <span class="comment"> * more robust.</span>
+<a name="l00049"></a>00049 <span class="comment"> */</span>
+<a name="l00050"></a>00050 <span class="preprocessor">#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_RIGHTS</span>
+<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#error The security return codes must be added to support this LDAP toolkit.</span>
+<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00054"></a>00054 <span class="preprocessor"></span>
+<a name="l00055"></a>00055 <span class="preprocessor">#if defined(LDAP_SECURITY_ERROR)</span>
+<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_SECURITY_ERROR LDAP_SECURITY_ERROR</span>
+<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_SECURITY_ERROR(n)      \</span>
+<a name="l00059"></a>00059 <span class="preprocessor">    (LDAP_INAPPROPRIATE_AUTH == n) ? 1 \</span>
+<a name="l00060"></a>00060 <span class="preprocessor">    : (LDAP_INVALID_CREDENTIALS == n) ? 1 \</span>
+<a name="l00061"></a>00061 <span class="preprocessor">    : (APU_LDAP_INSUFFICIENT_ACCESS == n) ? 1 \</span>
+<a name="l00062"></a>00062 <span class="preprocessor">    : 0</span>
+<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
+<a name="l00064"></a>00064 <span class="preprocessor"></span>
+<a name="l00065"></a>00065 <span class="comment"></span>
+<a name="l00066"></a>00066 <span class="comment">/**</span>
+<a name="l00067"></a>00067 <span class="comment"> * APR LDAP SSL Initialise function</span>
+<a name="l00068"></a>00068 <span class="comment"> *</span>
+<a name="l00069"></a>00069 <span class="comment"> * This function initialises SSL on the underlying LDAP toolkit</span>
+<a name="l00070"></a>00070 <span class="comment"> * if this is necessary.</span>
+<a name="l00071"></a>00071 <span class="comment"> *</span>
+<a name="l00072"></a>00072 <span class="comment"> * If a CA certificate is provided, this is set, however the setting</span>
+<a name="l00073"></a>00073 <span class="comment"> * of certificates via this method has been deprecated and will be removed in</span>
+<a name="l00074"></a>00074 <span class="comment"> * APR v2.0.</span>
+<a name="l00075"></a>00075 <span class="comment"> *</span>
+<a name="l00076"></a>00076 <span class="comment"> * The apr_ldap_set_option() function with the APR_LDAP_OPT_TLS_CERT option</span>
+<a name="l00077"></a>00077 <span class="comment"> * should be used instead to set certificates.</span>
+<a name="l00078"></a>00078 <span class="comment"> *</span>
+<a name="l00079"></a>00079 <span class="comment"> * If SSL support is not available on this platform, or a problem</span>
+<a name="l00080"></a>00080 <span class="comment"> * was encountered while trying to set the certificate, the function</span>
+<a name="l00081"></a>00081 <span class="comment"> * will return APR_EGENERAL. Further LDAP specific error information</span>
+<a name="l00082"></a>00082 <span class="comment"> * can be found in result_err.</span>
+<a name="l00083"></a>00083 <span class="comment"> * @param pool The pool to use</span>
+<a name="l00084"></a>00084 <span class="comment"> * @param cert_auth_file The name of the certificate to use, can be NULL</span>
+<a name="l00085"></a>00085 <span class="comment"> * @param cert_file_type The type of certificate specified. See the</span>
+<a name="l00086"></a>00086 <span class="comment"> * apr_ldap_set_option() APR_LDAP_OPT_TLS_CERT option for details.</span>
+<a name="l00087"></a>00087 <span class="comment"> * @param result_err The returned result</span>
+<a name="l00088"></a>00088 <span class="comment"> */</span>
+<a name="l00089"></a>00089 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) apr_ldap_ssl_init(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
+<a name="l00090"></a>00090                                         const <span class="keywordtype">char</span> *cert_auth_file,
+<a name="l00091"></a>00091                                         <span class="keywordtype">int</span> cert_file_type,
+<a name="l00092"></a>00092                                         apr_ldap_err_t **result_err);
+<a name="l00093"></a>00093 <span class="comment"></span>
+<a name="l00094"></a>00094 <span class="comment">/**</span>
+<a name="l00095"></a>00095 <span class="comment"> * APR LDAP SSL De-Initialise function</span>
+<a name="l00096"></a>00096 <span class="comment"> *</span>
+<a name="l00097"></a>00097 <span class="comment"> * This function tears down any SSL certificate setup previously</span>
+<a name="l00098"></a>00098 <span class="comment"> * set using apr_ldap_ssl_init(). It should be called to clean</span>
+<a name="l00099"></a>00099 <span class="comment"> * up if a graceful restart of a service is attempted.</span>
+<a name="l00100"></a>00100 <span class="comment"> * @todo currently we do not check whether apr_ldap_ssl_init()</span>
+<a name="l00101"></a>00101 <span class="comment"> * has been called first - we probably should.</span>
+<a name="l00102"></a>00102 <span class="comment"> */</span>
+<a name="l00103"></a>00103 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) apr_ldap_ssl_deinit(<span class="keywordtype">void</span>);
+<a name="l00104"></a>00104 <span class="comment"></span>
+<a name="l00105"></a>00105 <span class="comment">/**</span>
+<a name="l00106"></a>00106 <span class="comment"> * APR LDAP initialise function</span>
+<a name="l00107"></a>00107 <span class="comment"> *</span>
+<a name="l00108"></a>00108 <span class="comment"> * This function is responsible for initialising an LDAP</span>
+<a name="l00109"></a>00109 <span class="comment"> * connection in a toolkit independant way. It does the</span>
+<a name="l00110"></a>00110 <span class="comment"> * job of ldap_init() from the C api.</span>
+<a name="l00111"></a>00111 <span class="comment"> *</span>
+<a name="l00112"></a>00112 <span class="comment"> * It handles both the SSL and non-SSL case, and attempts</span>
+<a name="l00113"></a>00113 <span class="comment"> * to hide the complexity setup from the user. This function</span>
+<a name="l00114"></a>00114 <span class="comment"> * assumes that any certificate setup necessary has already</span>
+<a name="l00115"></a>00115 <span class="comment"> * been done.</span>
+<a name="l00116"></a>00116 <span class="comment"> *</span>
+<a name="l00117"></a>00117 <span class="comment"> * If SSL or STARTTLS needs to be enabled, and the underlying</span>
+<a name="l00118"></a>00118 <span class="comment"> * toolkit supports it, the following values are accepted for</span>
+<a name="l00119"></a>00119 <span class="comment"> * secure:</span>
+<a name="l00120"></a>00120 <span class="comment"> *</span>
+<a name="l00121"></a>00121 <span class="comment"> * APR_LDAP_NONE: No encryption</span>
+<a name="l00122"></a>00122 <span class="comment"> * APR_LDAP_SSL: SSL encryption (ldaps://)</span>
+<a name="l00123"></a>00123 <span class="comment"> * APR_LDAP_STARTTLS: Force STARTTLS on ldap://</span>
+<a name="l00124"></a>00124 <span class="comment"> * @remark The Novell toolkit is only able to set the SSL mode via this</span>
+<a name="l00125"></a>00125 <span class="comment"> * function. To work around this limitation, set the SSL mode here if no</span>
+<a name="l00126"></a>00126 <span class="comment"> * per connection client certificates are present, otherwise set secure</span>
+<a name="l00127"></a>00127 <span class="comment"> * APR_LDAP_NONE here, then set the per connection client certificates,</span>
+<a name="l00128"></a>00128 <span class="comment"> * followed by setting the SSL mode via apr_ldap_set_option(). As Novell</span>
+<a name="l00129"></a>00129 <span class="comment"> * does not support per connection client certificates, this problem is</span>
+<a name="l00130"></a>00130 <span class="comment"> * worked around while still being compatible with other LDAP toolkits.</span>
+<a name="l00131"></a>00131 <span class="comment"> * @param pool The pool to use</span>
+<a name="l00132"></a>00132 <span class="comment"> * @param ldap The LDAP handle</span>
+<a name="l00133"></a>00133 <span class="comment"> * @param hostname The name of the host to connect to. This can be either a</span>
+<a name="l00134"></a>00134 <span class="comment"> * DNS name, or an IP address.</span>
+<a name="l00135"></a>00135 <span class="comment"> * @param portno The port to connect to</span>
+<a name="l00136"></a>00136 <span class="comment"> * @param secure The security mode to set</span>
+<a name="l00137"></a>00137 <span class="comment"> * @param result_err The returned result</span>
+<a name="l00138"></a>00138 <span class="comment"> */</span>
+<a name="l00139"></a>00139 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) apr_ldap_init(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
+<a name="l00140"></a>00140                                     LDAP **ldap,
+<a name="l00141"></a>00141                                     const <span class="keywordtype">char</span> *hostname,
+<a name="l00142"></a>00142                                     <span class="keywordtype">int</span> portno,
+<a name="l00143"></a>00143                                     <span class="keywordtype">int</span> secure,
+<a name="l00144"></a>00144                                     apr_ldap_err_t **result_err);
+<a name="l00145"></a>00145 <span class="comment"></span>
+<a name="l00146"></a>00146 <span class="comment">/**</span>
+<a name="l00147"></a>00147 <span class="comment"> * APR LDAP info function</span>
+<a name="l00148"></a>00148 <span class="comment"> *</span>
+<a name="l00149"></a>00149 <span class="comment"> * This function returns a string describing the LDAP toolkit</span>
+<a name="l00150"></a>00150 <span class="comment"> * currently in use. The string is placed inside result_err-&gt;reason.</span>
+<a name="l00151"></a>00151 <span class="comment"> * @param pool The pool to use</span>
+<a name="l00152"></a>00152 <span class="comment"> * @param result_err The returned result</span>
+<a name="l00153"></a>00153 <span class="comment"> */</span>
+<a name="l00154"></a>00154 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) apr_ldap_info(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
+<a name="l00155"></a>00155                                     apr_ldap_err_t **result_err);
+<a name="l00156"></a>00156 
+<a name="l00157"></a>00157 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00158"></a>00158 <span class="preprocessor"></span>}
+<a name="l00159"></a>00159 <span class="preprocessor">#endif</span>
+<a name="l00160"></a>00160 <span class="preprocessor"></span>
+<a name="l00161"></a>00161 <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_LDAP */</span>
+<a name="l00162"></a>00162 <span class="comment"></span>
+<a name="l00163"></a>00163 <span class="comment">/** @} */</span>
+<a name="l00164"></a>00164 
+<a name="l00165"></a>00165 <span class="preprocessor">#endif </span><span class="comment">/* APR_LDAP_URL_H */</span>
+</pre></div></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>

Added: apr/site/trunk/docs/docs/apr/trunk/apr__ldap__init_8h.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__ldap__init_8h.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__ldap__init_8h.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__ldap__init_8h.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,45 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_ldap_init.h File Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li><a href="examples.html"><span>Examples</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+      <li><a href="globals.html"><span>Globals</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>apr_ldap_init.h File Reference</h1>APR-UTIL LDAP ldap_init() functions.  
+<a href="#_details">More...</a>
+<p>
+<code>#include &quot;<a class="el" href="apr__ldap_8h-source.html">apr_ldap.h</a>&quot;</code><br>
+
+<p>
+<a href="apr__ldap__init_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+APR-UTIL LDAP ldap_init() functions. 
+<p>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>

Added: apr/site/trunk/docs/docs/apr/trunk/apr__ldap__option_8h-source.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__ldap__option_8h-source.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__ldap__option_8h-source.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__ldap__option_8h-source.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,285 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_ldap_option.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li><a href="examples.html"><span>Examples</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+      <li><a href="globals.html"><span>Globals</span></a></li>
+    </ul>
+  </div>
+<h1>apr_ldap_option.h</h1><a href="apr__ldap__option_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
+<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements.  See the NOTICE file distributed with</span>
+<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
+<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
+<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
+<a name="l00006"></a>00006 <span class="comment"> * the License.  You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment"> *</span>
+<a name="l00008"></a>00008 <span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment"> *</span>
+<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
+<a name="l00015"></a>00015 <span class="comment"> */</span>
+<a name="l00016"></a>00016 <span class="comment"></span>
+<a name="l00017"></a>00017 <span class="comment">/**</span>
+<a name="l00018"></a>00018 <span class="comment"> * @file apr_ldap_option.h</span>
+<a name="l00019"></a>00019 <span class="comment"> * @brief  APR-UTIL LDAP ldap_*_option() functions</span>
+<a name="l00020"></a>00020 <span class="comment"> */</span>
+<a name="l00021"></a>00021 <span class="preprocessor">#ifndef APR_LDAP_OPTION_H</span>
+<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define APR_LDAP_OPTION_H</span>
+<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00024"></a>00024 <span class="comment">/**</span>
+<a name="l00025"></a>00025 <span class="comment"> * @addtogroup APR_Util_LDAP</span>
+<a name="l00026"></a>00026 <span class="comment"> * @{</span>
+<a name="l00027"></a>00027 <span class="comment"> */</span>
+<a name="l00028"></a>00028 
+<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="apr__ldap_8h.html" title="APR-UTIL LDAP.">apr_ldap.h</a>"</span>
+<a name="l00030"></a>00030 
+<a name="l00031"></a>00031 <span class="preprocessor">#if APR_HAS_LDAP</span>
+<a name="l00032"></a>00032 <span class="preprocessor"></span>
+<a name="l00033"></a>00033 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00035"></a>00035 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
+<a name="l00036"></a>00036 
+<a name="l00037"></a>00037 <span class="comment">/*</span>
+<a name="l00038"></a>00038 <span class="comment"> * The following defines handle the different TLS certificate</span>
+<a name="l00039"></a>00039 <span class="comment"> * options available. If these options are missing, APR will try and</span>
+<a name="l00040"></a>00040 <span class="comment"> * emulate support for this using the deprecated ldap_start_tls_s()</span>
+<a name="l00041"></a>00041 <span class="comment"> * function.</span>
+<a name="l00042"></a>00042 <span class="comment"> */</span><span class="comment"></span>
+<a name="l00043"></a>00043 <span class="comment">/**</span>
+<a name="l00044"></a>00044 <span class="comment"> * Set SSL mode to one of APR_LDAP_NONE, APR_LDAP_SSL, APR_LDAP_STARTTLS</span>
+<a name="l00045"></a>00045 <span class="comment"> * or APR_LDAP_STOPTLS.</span>
+<a name="l00046"></a>00046 <span class="comment"> */</span>
+<a name="l00047"></a>00047 <span class="preprocessor">#define APR_LDAP_OPT_TLS 0x6fff</span>
+<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="comment">/**</span>
+<a name="l00049"></a>00049 <span class="comment"> * Set zero or more CA certificates, client certificates or private</span>
+<a name="l00050"></a>00050 <span class="comment"> * keys globally, or per connection (where supported).</span>
+<a name="l00051"></a>00051 <span class="comment"> */</span>
+<a name="l00052"></a>00052 <span class="preprocessor">#define APR_LDAP_OPT_TLS_CERT 0x6ffe</span>
+<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="comment">/**</span>
+<a name="l00054"></a>00054 <span class="comment"> * Set the LDAP library to no verify the server certificate.  This means</span>
+<a name="l00055"></a>00055 <span class="comment"> * all servers are considered trusted.</span>
+<a name="l00056"></a>00056 <span class="comment"> */</span>
+<a name="l00057"></a>00057 <span class="preprocessor">#define APR_LDAP_OPT_VERIFY_CERT 0x6ffd</span>
+<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="comment">/**</span>
+<a name="l00059"></a>00059 <span class="comment"> * Set the LDAP library to indicate if referrals should be chased during</span>
+<a name="l00060"></a>00060 <span class="comment"> * LDAP searches.</span>
+<a name="l00061"></a>00061 <span class="comment"> */</span>
+<a name="l00062"></a>00062 <span class="preprocessor">#define APR_LDAP_OPT_REFERRALS 0x6ffc</span>
+<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="comment">/**</span>
+<a name="l00064"></a>00064 <span class="comment"> * Set the LDAP library to indicate a maximum number of referral hops to</span>
+<a name="l00065"></a>00065 <span class="comment"> * chase before giving up on the search.</span>
+<a name="l00066"></a>00066 <span class="comment"> */</span>
+<a name="l00067"></a>00067 <span class="preprocessor">#define APR_LDAP_OPT_REFHOPLIMIT 0x6ffb</span>
+<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00069"></a>00069 <span class="comment">/**</span>
+<a name="l00070"></a>00070 <span class="comment"> * Structures for the apr_set_option() cases</span>
+<a name="l00071"></a>00071 <span class="comment"> */</span>
+<a name="l00072"></a>00072 <span class="comment"></span>
+<a name="l00073"></a>00073 <span class="comment">/**</span>
+<a name="l00074"></a>00074 <span class="comment"> * APR_LDAP_OPT_TLS_CERT</span>
+<a name="l00075"></a>00075 <span class="comment"> *</span>
+<a name="l00076"></a>00076 <span class="comment"> * This structure includes possible options to set certificates on</span>
+<a name="l00077"></a>00077 <span class="comment"> * system initialisation. Different SDKs have different certificate</span>
+<a name="l00078"></a>00078 <span class="comment"> * requirements, and to achieve this multiple certificates must be</span>
+<a name="l00079"></a>00079 <span class="comment"> * specified at once passed as an (apr_array_header_t *).</span>
+<a name="l00080"></a>00080 <span class="comment"> *</span>
+<a name="l00081"></a>00081 <span class="comment"> * Netscape:</span>
+<a name="l00082"></a>00082 <span class="comment"> * Needs the CA cert database (cert7.db), the client cert database (key3.db)</span>
+<a name="l00083"></a>00083 <span class="comment"> * and the security module file (secmod.db) set at the system initialisation</span>
+<a name="l00084"></a>00084 <span class="comment"> * time. Three types are supported: APR_LDAP_CERT7_DB, APR_LDAP_KEY3_DB and</span>
+<a name="l00085"></a>00085 <span class="comment"> * APR_LDAP_SECMOD.</span>
+<a name="l00086"></a>00086 <span class="comment"> *</span>
+<a name="l00087"></a>00087 <span class="comment"> * To specify a client cert connection, a certificate nickname needs to be</span>
+<a name="l00088"></a>00088 <span class="comment"> * provided with a type of APR_LDAP_CERT.</span>
+<a name="l00089"></a>00089 <span class="comment"> * int ldapssl_enable_clientauth( LDAP *ld, char *keynickname,</span>
+<a name="l00090"></a>00090 <span class="comment"> * char *keypasswd, char *certnickname );</span>
+<a name="l00091"></a>00091 <span class="comment"> * keynickname is currently not used, and should be set to ""</span>
+<a name="l00092"></a>00092 <span class="comment"> *</span>
+<a name="l00093"></a>00093 <span class="comment"> * Novell:</span>
+<a name="l00094"></a>00094 <span class="comment"> * Needs CA certificates and client certificates set at system initialisation</span>
+<a name="l00095"></a>00095 <span class="comment"> * time. Three types are supported: APR_LDAP_CA*, APR_LDAP_CERT* and</span>
+<a name="l00096"></a>00096 <span class="comment"> * APR_LDAP_KEY*.</span>
+<a name="l00097"></a>00097 <span class="comment"> *</span>
+<a name="l00098"></a>00098 <span class="comment"> * Certificates cannot be specified per connection.</span>
+<a name="l00099"></a>00099 <span class="comment"> *</span>
+<a name="l00100"></a>00100 <span class="comment"> * The functions used are:</span>
+<a name="l00101"></a>00101 <span class="comment"> * ldapssl_add_trusted_cert(serverTrustedRoot, serverTrustedRootEncoding);</span>
+<a name="l00102"></a>00102 <span class="comment"> * Clients certs and keys are set at system initialisation time with</span>
+<a name="l00103"></a>00103 <span class="comment"> * int ldapssl_set_client_cert (</span>
+<a name="l00104"></a>00104 <span class="comment"> *  void   *cert,</span>
+<a name="l00105"></a>00105 <span class="comment"> *  int     type</span>
+<a name="l00106"></a>00106 <span class="comment"> *  void   *password); </span>
+<a name="l00107"></a>00107 <span class="comment"> * type can be LDAPSSL_CERT_FILETYPE_B64 or LDAPSSL_CERT_FILETYPE_DER</span>
+<a name="l00108"></a>00108 <span class="comment"> *  ldapssl_set_client_private_key(clientPrivateKey,</span>
+<a name="l00109"></a>00109 <span class="comment"> *                                 clientPrivateKeyEncoding,</span>
+<a name="l00110"></a>00110 <span class="comment"> *                                 clientPrivateKeyPassword);</span>
+<a name="l00111"></a>00111 <span class="comment"> *</span>
+<a name="l00112"></a>00112 <span class="comment"> * OpenSSL:</span>
+<a name="l00113"></a>00113 <span class="comment"> * Needs one or more CA certificates to be set at system initialisation time</span>
+<a name="l00114"></a>00114 <span class="comment"> * with a type of APR_LDAP_CA*.</span>
+<a name="l00115"></a>00115 <span class="comment"> *</span>
+<a name="l00116"></a>00116 <span class="comment"> * May have one or more client certificates set per connection with a type of</span>
+<a name="l00117"></a>00117 <span class="comment"> * APR_LDAP_CERT*, and keys with APR_LDAP_KEY*.</span>
+<a name="l00118"></a>00118 <span class="comment"> */</span><span class="comment"></span>
+<a name="l00119"></a>00119 <span class="comment">/** CA certificate type unknown */</span>
+<a name="l00120"></a>00120 <span class="preprocessor">#define APR_LDAP_CA_TYPE_UNKNOWN    0</span>
+<a name="l00121"></a>00121 <span class="preprocessor"></span><span class="comment">/** binary DER encoded CA certificate */</span>
+<a name="l00122"></a>00122 <span class="preprocessor">#define APR_LDAP_CA_TYPE_DER        1</span>
+<a name="l00123"></a>00123 <span class="preprocessor"></span><span class="comment">/** PEM encoded CA certificate */</span>
+<a name="l00124"></a>00124 <span class="preprocessor">#define APR_LDAP_CA_TYPE_BASE64     2</span>
+<a name="l00125"></a>00125 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla cert7.db CA certificate database */</span>
+<a name="l00126"></a>00126 <span class="preprocessor">#define APR_LDAP_CA_TYPE_CERT7_DB   3</span>
+<a name="l00127"></a>00127 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla secmod file */</span>
+<a name="l00128"></a>00128 <span class="preprocessor">#define APR_LDAP_CA_TYPE_SECMOD     4</span>
+<a name="l00129"></a>00129 <span class="preprocessor"></span><span class="comment">/** Client certificate type unknown */</span>
+<a name="l00130"></a>00130 <span class="preprocessor">#define APR_LDAP_CERT_TYPE_UNKNOWN  5</span>
+<a name="l00131"></a>00131 <span class="preprocessor"></span><span class="comment">/** binary DER encoded client certificate */</span>
+<a name="l00132"></a>00132 <span class="preprocessor">#define APR_LDAP_CERT_TYPE_DER      6</span>
+<a name="l00133"></a>00133 <span class="preprocessor"></span><span class="comment">/** PEM encoded client certificate */</span>
+<a name="l00134"></a>00134 <span class="preprocessor">#define APR_LDAP_CERT_TYPE_BASE64   7</span>
+<a name="l00135"></a>00135 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla key3.db client certificate database */</span>
+<a name="l00136"></a>00136 <span class="preprocessor">#define APR_LDAP_CERT_TYPE_KEY3_DB  8</span>
+<a name="l00137"></a>00137 <span class="preprocessor"></span><span class="comment">/** Netscape/Mozilla client certificate nickname */</span>
+<a name="l00138"></a>00138 <span class="preprocessor">#define APR_LDAP_CERT_TYPE_NICKNAME 9</span>
+<a name="l00139"></a>00139 <span class="preprocessor"></span><span class="comment">/** Private key type unknown */</span>
+<a name="l00140"></a>00140 <span class="preprocessor">#define APR_LDAP_KEY_TYPE_UNKNOWN   10</span>
+<a name="l00141"></a>00141 <span class="preprocessor"></span><span class="comment">/** binary DER encoded private key */</span>
+<a name="l00142"></a>00142 <span class="preprocessor">#define APR_LDAP_KEY_TYPE_DER       11</span>
+<a name="l00143"></a>00143 <span class="preprocessor"></span><span class="comment">/** PEM encoded private key */</span>
+<a name="l00144"></a>00144 <span class="preprocessor">#define APR_LDAP_KEY_TYPE_BASE64    12</span>
+<a name="l00145"></a>00145 <span class="preprocessor"></span><span class="comment">/** PKCS#12 encoded client certificate */</span>
+<a name="l00146"></a>00146 <span class="preprocessor">#define APR_LDAP_CERT_TYPE_PFX      13</span>
+<a name="l00147"></a>00147 <span class="preprocessor"></span><span class="comment">/** PKCS#12 encoded private key */</span>
+<a name="l00148"></a>00148 <span class="preprocessor">#define APR_LDAP_KEY_TYPE_PFX       14</span>
+<a name="l00149"></a>00149 <span class="preprocessor"></span><span class="comment">/** Openldap directory full of base64-encoded cert </span>
+<a name="l00150"></a>00150 <span class="comment"> * authorities with hashes in corresponding .0 directory</span>
+<a name="l00151"></a>00151 <span class="comment"> */</span>
+<a name="l00152"></a>00152 <span class="preprocessor">#define APR_LDAP_CA_TYPE_CACERTDIR_BASE64 15</span>
+<a name="l00153"></a>00153 <span class="preprocessor"></span>
+<a name="l00154"></a>00154 <span class="comment"></span>
+<a name="l00155"></a>00155 <span class="comment">/**</span>
+<a name="l00156"></a>00156 <span class="comment"> * Certificate structure.</span>
+<a name="l00157"></a>00157 <span class="comment"> *</span>
+<a name="l00158"></a>00158 <span class="comment"> * This structure is used to store certificate details. An array of</span>
+<a name="l00159"></a>00159 <span class="comment"> * these structures is passed to apr_ldap_set_option() to set CA</span>
+<a name="l00160"></a>00160 <span class="comment"> * and client certificates.</span>
+<a name="l00161"></a>00161 <span class="comment"> * @param type Type of certificate APR_LDAP_*_TYPE_*</span>
+<a name="l00162"></a>00162 <span class="comment"> * @param path Path, file or nickname of the certificate</span>
+<a name="l00163"></a>00163 <span class="comment"> * @param password Optional password, can be NULL</span>
+<a name="l00164"></a>00164 <span class="comment"> */</span>
+<a name="l00165"></a>00165 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_ldap_opt_tls_cert_t apr_ldap_opt_tls_cert_t;
+<a name="l00166"></a>00166 <span class="keyword">struct </span>apr_ldap_opt_tls_cert_t {
+<a name="l00167"></a>00167     <span class="keywordtype">int</span> type;
+<a name="l00168"></a>00168     <span class="keyword">const</span> <span class="keywordtype">char</span> *path;
+<a name="l00169"></a>00169     <span class="keyword">const</span> <span class="keywordtype">char</span> *password;
+<a name="l00170"></a>00170 };
+<a name="l00171"></a>00171 <span class="comment"></span>
+<a name="l00172"></a>00172 <span class="comment">/**</span>
+<a name="l00173"></a>00173 <span class="comment"> * APR_LDAP_OPT_TLS</span>
+<a name="l00174"></a>00174 <span class="comment"> *</span>
+<a name="l00175"></a>00175 <span class="comment"> * This sets the SSL level on the LDAP handle.</span>
+<a name="l00176"></a>00176 <span class="comment"> *</span>
+<a name="l00177"></a>00177 <span class="comment"> * Netscape/Mozilla:</span>
+<a name="l00178"></a>00178 <span class="comment"> * Supports SSL, but not STARTTLS</span>
+<a name="l00179"></a>00179 <span class="comment"> * SSL is enabled by calling ldapssl_install_routines().</span>
+<a name="l00180"></a>00180 <span class="comment"> *</span>
+<a name="l00181"></a>00181 <span class="comment"> * Novell:</span>
+<a name="l00182"></a>00182 <span class="comment"> * Supports SSL and STARTTLS.</span>
+<a name="l00183"></a>00183 <span class="comment"> * SSL is enabled by calling ldapssl_install_routines(). Note that calling</span>
+<a name="l00184"></a>00184 <span class="comment"> * other ldap functions before ldapssl_install_routines() may cause this</span>
+<a name="l00185"></a>00185 <span class="comment"> * function to fail.</span>
+<a name="l00186"></a>00186 <span class="comment"> * STARTTLS is enabled by calling ldapssl_start_tls_s() after calling</span>
+<a name="l00187"></a>00187 <span class="comment"> * ldapssl_install_routines() (check this).</span>
+<a name="l00188"></a>00188 <span class="comment"> *</span>
+<a name="l00189"></a>00189 <span class="comment"> * OpenLDAP:</span>
+<a name="l00190"></a>00190 <span class="comment"> * Supports SSL and supports STARTTLS, but none of this is documented:</span>
+<a name="l00191"></a>00191 <span class="comment"> * http://www.openldap.org/lists/openldap-software/200409/msg00618.html</span>
+<a name="l00192"></a>00192 <span class="comment"> * Documentation for both SSL support and STARTTLS has been deleted from</span>
+<a name="l00193"></a>00193 <span class="comment"> * the OpenLDAP documentation and website.</span>
+<a name="l00194"></a>00194 <span class="comment"> */</span>
+<a name="l00195"></a>00195 <span class="comment"></span>
+<a name="l00196"></a>00196 <span class="comment">/** No encryption */</span>
+<a name="l00197"></a>00197 <span class="preprocessor">#define APR_LDAP_NONE 0</span>
+<a name="l00198"></a>00198 <span class="preprocessor"></span><span class="comment">/** SSL encryption (ldaps://) */</span>
+<a name="l00199"></a>00199 <span class="preprocessor">#define APR_LDAP_SSL 1</span>
+<a name="l00200"></a>00200 <span class="preprocessor"></span><span class="comment">/** TLS encryption (STARTTLS) */</span>
+<a name="l00201"></a>00201 <span class="preprocessor">#define APR_LDAP_STARTTLS 2</span>
+<a name="l00202"></a>00202 <span class="preprocessor"></span><span class="comment">/** end TLS encryption (STOPTLS) */</span>
+<a name="l00203"></a>00203 <span class="preprocessor">#define APR_LDAP_STOPTLS 3</span>
+<a name="l00204"></a>00204 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00205"></a>00205 <span class="comment">/**</span>
+<a name="l00206"></a>00206 <span class="comment"> * APR LDAP get option function</span>
+<a name="l00207"></a>00207 <span class="comment"> *</span>
+<a name="l00208"></a>00208 <span class="comment"> * This function gets option values from a given LDAP session if</span>
+<a name="l00209"></a>00209 <span class="comment"> * one was specified. It maps to the native ldap_get_option() function.</span>
+<a name="l00210"></a>00210 <span class="comment"> * @param pool The pool to use</span>
+<a name="l00211"></a>00211 <span class="comment"> * @param ldap The LDAP handle</span>
+<a name="l00212"></a>00212 <span class="comment"> * @param option The LDAP_OPT_* option to return</span>
+<a name="l00213"></a>00213 <span class="comment"> * @param outvalue The value returned (if any)</span>
+<a name="l00214"></a>00214 <span class="comment"> * @param result_err The apr_ldap_err_t structure contained detailed results</span>
+<a name="l00215"></a>00215 <span class="comment"> *        of the operation.</span>
+<a name="l00216"></a>00216 <span class="comment"> */</span>
+<a name="l00217"></a>00217 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) apr_ldap_get_option(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
+<a name="l00218"></a>00218                                           LDAP *ldap,
+<a name="l00219"></a>00219                                           <span class="keywordtype">int</span> option,
+<a name="l00220"></a>00220                                           <span class="keywordtype">void</span> *outvalue,
+<a name="l00221"></a>00221                                           apr_ldap_err_t **result_err);
+<a name="l00222"></a>00222 <span class="comment"></span>
+<a name="l00223"></a>00223 <span class="comment">/**</span>
+<a name="l00224"></a>00224 <span class="comment"> * APR LDAP set option function</span>
+<a name="l00225"></a>00225 <span class="comment"> * </span>
+<a name="l00226"></a>00226 <span class="comment"> * This function sets option values to a given LDAP session if</span>
+<a name="l00227"></a>00227 <span class="comment"> * one was specified. It maps to the native ldap_set_option() function.</span>
+<a name="l00228"></a>00228 <span class="comment"> * </span>
+<a name="l00229"></a>00229 <span class="comment"> * Where an option is not supported by an LDAP toolkit, this function</span>
+<a name="l00230"></a>00230 <span class="comment"> * will try and apply legacy functions to achieve the same effect,</span>
+<a name="l00231"></a>00231 <span class="comment"> * depending on the platform.</span>
+<a name="l00232"></a>00232 <span class="comment"> * @param pool The pool to use</span>
+<a name="l00233"></a>00233 <span class="comment"> * @param ldap The LDAP handle</span>
+<a name="l00234"></a>00234 <span class="comment"> * @param option The LDAP_OPT_* option to set</span>
+<a name="l00235"></a>00235 <span class="comment"> * @param invalue The value to set</span>
+<a name="l00236"></a>00236 <span class="comment"> * @param result_err The apr_ldap_err_t structure contained detailed results</span>
+<a name="l00237"></a>00237 <span class="comment"> *        of the operation.</span>
+<a name="l00238"></a>00238 <span class="comment"> */</span>
+<a name="l00239"></a>00239 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) apr_ldap_set_option(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
+<a name="l00240"></a>00240                                           LDAP *ldap,
+<a name="l00241"></a>00241                                           <span class="keywordtype">int</span> option,
+<a name="l00242"></a>00242                                           const <span class="keywordtype">void</span> *invalue,
+<a name="l00243"></a>00243                                           apr_ldap_err_t **result_err);
+<a name="l00244"></a>00244 
+<a name="l00245"></a>00245 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00246"></a>00246 <span class="preprocessor"></span>}
+<a name="l00247"></a>00247 <span class="preprocessor">#endif</span>
+<a name="l00248"></a>00248 <span class="preprocessor"></span>
+<a name="l00249"></a>00249 <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_LDAP */</span>
+<a name="l00250"></a>00250 <span class="comment"></span>
+<a name="l00251"></a>00251 <span class="comment">/** @} */</span>
+<a name="l00252"></a>00252 
+<a name="l00253"></a>00253 <span class="preprocessor">#endif </span><span class="comment">/* APR_LDAP_OPTION_H */</span>
+<a name="l00254"></a>00254 
+</pre></div></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>

Added: apr/site/trunk/docs/docs/apr/trunk/apr__ldap__option_8h.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__ldap__option_8h.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__ldap__option_8h.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__ldap__option_8h.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,45 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_ldap_option.h File Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li><a href="examples.html"><span>Examples</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+      <li><a href="globals.html"><span>Globals</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>apr_ldap_option.h File Reference</h1>APR-UTIL LDAP ldap_*_option() functions.  
+<a href="#_details">More...</a>
+<p>
+<code>#include &quot;<a class="el" href="apr__ldap_8h-source.html">apr_ldap.h</a>&quot;</code><br>
+
+<p>
+<a href="apr__ldap__option_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+APR-UTIL LDAP ldap_*_option() functions. 
+<p>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>

Added: apr/site/trunk/docs/docs/apr/trunk/apr__ldap__rebind_8h-source.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__ldap__rebind_8h-source.html?rev=784636&view=auto
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__ldap__rebind_8h-source.html (added)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__ldap__rebind_8h-source.html Mon Jun 15 00:01:38 2009
@@ -0,0 +1,129 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Apache Portable Runtime: apr_ldap_rebind.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+      <li><a href="examples.html"><span>Examples</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+      <li><a href="globals.html"><span>Globals</span></a></li>
+    </ul>
+  </div>
+<h1>apr_ldap_rebind.h</h1><a href="apr__ldap__rebind_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
+<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements.  See the NOTICE file distributed with</span>
+<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
+<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
+<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
+<a name="l00006"></a>00006 <span class="comment"> * the License.  You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment"> *</span>
+<a name="l00008"></a>00008 <span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment"> *</span>
+<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
+<a name="l00015"></a>00015 <span class="comment"> */</span>
+<a name="l00016"></a>00016 <span class="comment"></span>
+<a name="l00017"></a>00017 <span class="comment">/**</span>
+<a name="l00018"></a>00018 <span class="comment"> * The APR LDAP rebind functions provide an implementation of</span>
+<a name="l00019"></a>00019 <span class="comment"> * a rebind procedure that can be used to allow clients to chase referrals,</span>
+<a name="l00020"></a>00020 <span class="comment"> * using the same credentials used to log in originally.</span>
+<a name="l00021"></a>00021 <span class="comment"> *</span>
+<a name="l00022"></a>00022 <span class="comment"> * Use of this implementation is optional.</span>
+<a name="l00023"></a>00023 <span class="comment"> *</span>
+<a name="l00024"></a>00024 <span class="comment"> * @file apr_ldap_rebind.h</span>
+<a name="l00025"></a>00025 <span class="comment"> * @brief Apache LDAP library</span>
+<a name="l00026"></a>00026 <span class="comment"> */</span>
+<a name="l00027"></a>00027 
+<a name="l00028"></a>00028 <span class="preprocessor">#ifndef APU_LDAP_REBIND_H</span>
+<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_REBIND_H</span>
+<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00031"></a>00031 <span class="comment">/**</span>
+<a name="l00032"></a>00032 <span class="comment"> * @addtogroup APR_Util_LDAP</span>
+<a name="l00033"></a>00033 <span class="comment"> * @{</span>
+<a name="l00034"></a>00034 <span class="comment"> **/</span>
+<a name="l00035"></a>00035 
+<a name="l00036"></a>00036 <span class="preprocessor">#if defined(DOXYGEN)</span>
+<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="apr__ldap_8h.html" title="APR-UTIL LDAP.">apr_ldap.h</a>"</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#endif</span>
+<a name="l00039"></a>00039 <span class="preprocessor"></span>
+<a name="l00040"></a>00040 <span class="comment">/*</span>
+<a name="l00041"></a>00041 <span class="comment"> * Handle the case when LDAP is enabled</span>
+<a name="l00042"></a>00042 <span class="comment"> */</span>
+<a name="l00043"></a>00043 <span class="preprocessor">#if APR_HAS_LDAP</span>
+<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00045"></a>00045 <span class="comment">/**</span>
+<a name="l00046"></a>00046 <span class="comment"> * APR LDAP initialize rebind lock</span>
+<a name="l00047"></a>00047 <span class="comment"> *</span>
+<a name="l00048"></a>00048 <span class="comment"> * This function creates the lock for controlling access to the xref list..</span>
+<a name="l00049"></a>00049 <span class="comment"> * @param pool Pool to use when creating the xref_lock.</span>
+<a name="l00050"></a>00050 <span class="comment"> */</span>
+<a name="l00051"></a>00051 APU_DECLARE_LDAP(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_ldap_rebind_init(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
+<a name="l00052"></a>00052 
+<a name="l00053"></a>00053 <span class="comment"></span>
+<a name="l00054"></a>00054 <span class="comment">/**</span>
+<a name="l00055"></a>00055 <span class="comment"> * APR LDAP rebind_add function</span>
+<a name="l00056"></a>00056 <span class="comment"> *</span>
+<a name="l00057"></a>00057 <span class="comment"> * This function creates a cross reference entry for the specified ldap</span>
+<a name="l00058"></a>00058 <span class="comment"> * connection. The rebind callback function will look up this ldap </span>
+<a name="l00059"></a>00059 <span class="comment"> * connection so it can retrieve the bindDN and bindPW for use in any </span>
+<a name="l00060"></a>00060 <span class="comment"> * binds while referrals are being chased.</span>
+<a name="l00061"></a>00061 <span class="comment"> *</span>
+<a name="l00062"></a>00062 <span class="comment"> * This function will add the callback to the LDAP handle passed in.</span>
+<a name="l00063"></a>00063 <span class="comment"> *</span>
+<a name="l00064"></a>00064 <span class="comment"> * A cleanup is registered within the pool provided to remove this</span>
+<a name="l00065"></a>00065 <span class="comment"> * entry when the pool is removed. Alternatively apr_ldap_rebind_remove()</span>
+<a name="l00066"></a>00066 <span class="comment"> * can be called to explicitly remove the entry at will.</span>
+<a name="l00067"></a>00067 <span class="comment"> *</span>
+<a name="l00068"></a>00068 <span class="comment"> * @param pool The pool to use</span>
+<a name="l00069"></a>00069 <span class="comment"> * @param ld The LDAP connectionhandle</span>
+<a name="l00070"></a>00070 <span class="comment"> * @param bindDN The bind DN to be used for any binds while chasing </span>
+<a name="l00071"></a>00071 <span class="comment"> *               referrals on this ldap connection.</span>
+<a name="l00072"></a>00072 <span class="comment"> * @param bindPW The bind Password to be used for any binds while </span>
+<a name="l00073"></a>00073 <span class="comment"> *               chasing referrals on this ldap connection.</span>
+<a name="l00074"></a>00074 <span class="comment"> */</span>
+<a name="l00075"></a>00075 APU_DECLARE_LDAP(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_ldap_rebind_add(<a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
+<a name="l00076"></a>00076                                                    LDAP *ld,
+<a name="l00077"></a>00077                                                    const <span class="keywordtype">char</span> *bindDN,
+<a name="l00078"></a>00078                                                    const <span class="keywordtype">char</span> *bindPW);
+<a name="l00079"></a>00079 <span class="comment"></span>
+<a name="l00080"></a>00080 <span class="comment">/**</span>
+<a name="l00081"></a>00081 <span class="comment"> * APR LDAP rebind_remove function</span>
+<a name="l00082"></a>00082 <span class="comment"> *</span>
+<a name="l00083"></a>00083 <span class="comment"> * This function removes the rebind cross reference entry for the</span>
+<a name="l00084"></a>00084 <span class="comment"> * specified ldap connection.</span>
+<a name="l00085"></a>00085 <span class="comment"> *</span>
+<a name="l00086"></a>00086 <span class="comment"> * If not explicitly removed, this function will be called automatically</span>
+<a name="l00087"></a>00087 <span class="comment"> * when the pool is cleaned up.</span>
+<a name="l00088"></a>00088 <span class="comment"> *</span>
+<a name="l00089"></a>00089 <span class="comment"> * @param ld The LDAP connectionhandle</span>
+<a name="l00090"></a>00090 <span class="comment"> */</span>
+<a name="l00091"></a>00091 APU_DECLARE_LDAP(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) apr_ldap_rebind_remove(LDAP *ld);
+<a name="l00092"></a>00092 
+<a name="l00093"></a>00093 <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_LDAP */</span>
+<a name="l00094"></a>00094 <span class="comment"></span>
+<a name="l00095"></a>00095 <span class="comment">/** @} */</span>
+<a name="l00096"></a>00096 
+<a name="l00097"></a>00097 <span class="preprocessor">#endif </span><span class="comment">/* APU_LDAP_REBIND_H */</span>
+<a name="l00098"></a>00098 
+</pre></div></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>



Mime
View raw message