/
usr
/
share
/
doc
/
libaprutil1-dev
/
html
/
Upload File
HOME
<!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"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Apache Portable Runtime Utility Library: apr_ldap_url.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime Utility Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); </script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">apr_ldap_url.h</div> </div> </div><!--header--> <div class="contents"> <a href="apr__ldap__url_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef APR_LDAP_URL_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define APR_LDAP_URL_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#if defined(DOXYGEN)</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="apr__ldap_8h.html">apr_ldap.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#if APR_HAS_LDAP</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "apu.h"</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "apr_pools.h"</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_ldap_url_desc_t {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">struct </span>apr_ldap_url_desc_t *lud_next;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">char</span> *lud_scheme;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">char</span> *lud_host;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">int</span> lud_port;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">char</span> *lud_dn;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">char</span> **lud_attrs;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">int</span> lud_scope;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">char</span> *lud_filter;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">char</span> **lud_exts;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> lud_crit_exts;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> } apr_ldap_url_desc_t;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#ifndef APR_LDAP_URL_SUCCESS</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define APR_LDAP_URL_SUCCESS 0x00 </span><span class="comment">/* Success */</span><span class="preprocessor"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_MEM 0x01 </span><span class="comment">/* can't allocate memory space */</span><span class="preprocessor"></span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_PARAM 0x02 </span><span class="comment">/* parameter is bad */</span><span class="preprocessor"></span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_BADSCHEME 0x03 </span><span class="comment">/* URL doesn't begin with "ldap[si]://" */</span><span class="preprocessor"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_BADENCLOSURE 0x04 </span><span class="comment">/* URL is missing trailing ">" */</span><span class="preprocessor"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_BADURL 0x05 </span><span class="comment">/* URL is bad */</span><span class="preprocessor"></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_BADHOST 0x06 </span><span class="comment">/* host port is bad */</span><span class="preprocessor"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_BADATTRS 0x07 </span><span class="comment">/* bad (or missing) attributes */</span><span class="preprocessor"></span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_BADSCOPE 0x08 </span><span class="comment">/* scope string is invalid (or missing) */</span><span class="preprocessor"></span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_BADFILTER 0x09 </span><span class="comment">/* bad or missing filter */</span><span class="preprocessor"></span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#define APR_LDAP_URL_ERR_BADEXTS 0x0a </span><span class="comment">/* bad or missing extensions */</span><span class="preprocessor"></span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> APU_DECLARE(<span class="keywordtype">int</span>) apr_ldap_is_ldap_url(<span class="keyword">const</span> <span class="keywordtype">char</span> *url);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> APU_DECLARE(<span class="keywordtype">int</span>) apr_ldap_is_ldaps_url(<span class="keyword">const</span> <span class="keywordtype">char</span> *url);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> APU_DECLARE(<span class="keywordtype">int</span>) apr_ldap_is_ldapi_url(<span class="keyword">const</span> <span class="keywordtype">char</span> *url);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> APU_DECLARE(<span class="keywordtype">int</span>) apr_ldap_url_parse_ext(apr_pool_t *pool,</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *url_in,</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  apr_ldap_url_desc_t **ludpp,</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <a class="code" href="structapr__ldap__err__t.html">apr_ldap_err_t</a> **result_err);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> APU_DECLARE(<span class="keywordtype">int</span>) apr_ldap_url_parse(apr_pool_t *pool,</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *url_in,</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  apr_ldap_url_desc_t **ludpp,</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="structapr__ldap__err__t.html">apr_ldap_err_t</a> **result_err);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_LDAP */</span><span class="preprocessor"></span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#endif </span><span class="comment">/* APR_LDAP_URL_H */</span><span class="preprocessor"></span></div><div class="ttc" id="apr__ldap_8h_html"><div class="ttname"><a href="apr__ldap_8h.html">apr_ldap.h</a></div><div class="ttdoc">APR-UTIL LDAP. </div></div> <div class="ttc" id="structapr__ldap__err__t_html"><div class="ttname"><a href="structapr__ldap__err__t.html">apr_ldap_err_t</a></div><div class="ttdef"><b>Definition:</b> apr_ldap.h:148</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>