trAvis - MANAGER
Edit File: group___a_p_r___util___escaping.html
<!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.5"/> <title>Apache Portable Runtime: Escape functions</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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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 class="header"> <div class="summary"> <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Escape functions<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a></div></div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:ga793ae1b187ce490c65eeee2eb59d2831"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga793ae1b187ce490c65eeee2eb59d2831">APR_ESCAPE_STRING</a>   (-1)</td></tr> <tr class="separator:ga793ae1b187ce490c65eeee2eb59d2831"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf9f0f1e78bc6fef3358ceced2e738b39"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gaf9f0f1e78bc6fef3358ceced2e738b39">APR_ESCAPE_LDAP_DN</a>   (0x01)</td></tr> <tr class="separator:gaf9f0f1e78bc6fef3358ceced2e738b39"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae42ad796afe5808eb98fc32c2345da0d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gae42ad796afe5808eb98fc32c2345da0d">APR_ESCAPE_LDAP_FILTER</a>   (0x02)</td></tr> <tr class="separator:gae42ad796afe5808eb98fc32c2345da0d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga047bef19e40c76df29afd5ec076af0fc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga047bef19e40c76df29afd5ec076af0fc">APR_ESCAPE_LDAP_ALL</a>   (0x03)</td></tr> <tr class="separator:ga047bef19e40c76df29afd5ec076af0fc"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:gafdfca9adc06570fa6efd802e24dce6d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gafdfca9adc06570fa6efd802e24dce6d1">apr_escape_shell</a> (char *escaped, const char *str, apr_ssize_t slen, apr_size_t *len)</td></tr> <tr class="separator:gafdfca9adc06570fa6efd802e24dce6d1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga81e97334f8033bfbc3acd5e15262323e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga81e97334f8033bfbc3acd5e15262323e">apr_pescape_shell</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *str)</td></tr> <tr class="separator:ga81e97334f8033bfbc3acd5e15262323e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9a6b08630ef5a605def1dfa4a54b026f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga9a6b08630ef5a605def1dfa4a54b026f">apr_unescape_url</a> (char *escaped, const char *url, apr_ssize_t slen, const char *forbid, const char *reserved, int plus, apr_size_t *len)</td></tr> <tr class="separator:ga9a6b08630ef5a605def1dfa4a54b026f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac713d5687a00134cef5c795dbf4e6dbe"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gac713d5687a00134cef5c795dbf4e6dbe">apr_punescape_url</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *url, const char *forbid, const char *reserved, int plus)</td></tr> <tr class="separator:gac713d5687a00134cef5c795dbf4e6dbe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2fba5a28f4924f00f1ba9a56bc87f651"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga2fba5a28f4924f00f1ba9a56bc87f651">apr_escape_path_segment</a> (char *escaped, const char *str, apr_ssize_t slen, apr_size_t *len)</td></tr> <tr class="separator:ga2fba5a28f4924f00f1ba9a56bc87f651"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga36bd45eb1f919fe61f04f5e9087c6242"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga36bd45eb1f919fe61f04f5e9087c6242">apr_pescape_path_segment</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *str)</td></tr> <tr class="separator:ga36bd45eb1f919fe61f04f5e9087c6242"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae67859a1d260f354c16e939d24d67058"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gae67859a1d260f354c16e939d24d67058">apr_escape_path</a> (char *escaped, const char *path, apr_ssize_t slen, int partial, apr_size_t *len)</td></tr> <tr class="separator:gae67859a1d260f354c16e939d24d67058"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gacd4fc208448eb07af16350802077783a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gacd4fc208448eb07af16350802077783a">apr_pescape_path</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *str, int partial)</td></tr> <tr class="separator:gacd4fc208448eb07af16350802077783a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0a2cb4e99758afd5bed8fd62df05e16f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga0a2cb4e99758afd5bed8fd62df05e16f">apr_escape_urlencoded</a> (char *escaped, const char *str, apr_ssize_t slen, apr_size_t *len)</td></tr> <tr class="separator:ga0a2cb4e99758afd5bed8fd62df05e16f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9caffb30731e3a07a8e23fa6464d35b5"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga9caffb30731e3a07a8e23fa6464d35b5">apr_pescape_urlencoded</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *str)</td></tr> <tr class="separator:ga9caffb30731e3a07a8e23fa6464d35b5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6973ca9a596c8fc9fc34eab647cff11c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga6973ca9a596c8fc9fc34eab647cff11c">apr_escape_entity</a> (char *escaped, const char *str, apr_ssize_t slen, int toasc, apr_size_t *len)</td></tr> <tr class="separator:ga6973ca9a596c8fc9fc34eab647cff11c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad99b0f505645b63b5f552f5d35f174af"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gad99b0f505645b63b5f552f5d35f174af">apr_pescape_entity</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *str, int toasc)</td></tr> <tr class="separator:gad99b0f505645b63b5f552f5d35f174af"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9b835b2da5bf35c33f6c69e8e3100c99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga9b835b2da5bf35c33f6c69e8e3100c99">apr_unescape_entity</a> (char *unescaped, const char *str, apr_ssize_t slen, apr_size_t *len)</td></tr> <tr class="separator:ga9b835b2da5bf35c33f6c69e8e3100c99"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabaaeff6e19e92cf1f138b21e87889e05"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gabaaeff6e19e92cf1f138b21e87889e05">apr_punescape_entity</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *str)</td></tr> <tr class="separator:gabaaeff6e19e92cf1f138b21e87889e05"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4ebbadaffa33c6aa34e92108c45cd38e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga4ebbadaffa33c6aa34e92108c45cd38e">apr_escape_echo</a> (char *escaped, const char *str, apr_ssize_t slen, int quote, apr_size_t *len)</td></tr> <tr class="separator:ga4ebbadaffa33c6aa34e92108c45cd38e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga1265c454e145b9fca52d2feafacd4a02"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga1265c454e145b9fca52d2feafacd4a02">apr_pescape_echo</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *str, int quote)</td></tr> <tr class="separator:ga1265c454e145b9fca52d2feafacd4a02"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac87b3c2f42fb60f6ea4d8321e60ce69e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gac87b3c2f42fb60f6ea4d8321e60ce69e">apr_escape_hex</a> (char *dest, const void *src, apr_size_t srclen, int colon, apr_size_t *len)</td></tr> <tr class="separator:gac87b3c2f42fb60f6ea4d8321e60ce69e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2a12cd35230cc148da52ea983da4b211"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga2a12cd35230cc148da52ea983da4b211">apr_pescape_hex</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const void *src, apr_size_t slen, int colon)</td></tr> <tr class="separator:ga2a12cd35230cc148da52ea983da4b211"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga98c3558219d7ce3dd29420c0124ddd73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga98c3558219d7ce3dd29420c0124ddd73">apr_unescape_hex</a> (void *dest, const char *str, apr_ssize_t slen, int colon, apr_size_t *len)</td></tr> <tr class="separator:ga98c3558219d7ce3dd29420c0124ddd73"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8cba37bcacb5e1c9440f2b35d44afc49"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga8cba37bcacb5e1c9440f2b35d44afc49">apr_punescape_hex</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *str, int colon, apr_size_t *len)</td></tr> <tr class="separator:ga8cba37bcacb5e1c9440f2b35d44afc49"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0c2848e1a814bfae5a619c5650096a65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#ga0c2848e1a814bfae5a619c5650096a65">apr_escape_ldap</a> (char *dest, const void *src, apr_ssize_t srclen, int flags, apr_size_t *len)</td></tr> <tr class="separator:ga0c2848e1a814bfae5a619c5650096a65"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa5f5b60078081ff23d529f0a1063daeb"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___escaping.html#gaa5f5b60078081ff23d529f0a1063daeb">apr_pescape_ldap</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const void *src, apr_ssize_t slen, int flags)</td></tr> <tr class="separator:gaa5f5b60078081ff23d529f0a1063daeb"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="ga047bef19e40c76df29afd5ec076af0fc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_ESCAPE_LDAP_ALL   (0x03)</td> </tr> </table> </div><div class="memdoc"> <p>Apply both RFC4514 and RFC4515 LDAP escaping. </p> </div> </div> <a class="anchor" id="gaf9f0f1e78bc6fef3358ceced2e738b39"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_ESCAPE_LDAP_DN   (0x01)</td> </tr> </table> </div><div class="memdoc"> <p>Apply LDAP distinguished name escaping as per RFC4514. </p> </div> </div> <a class="anchor" id="gae42ad796afe5808eb98fc32c2345da0d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_ESCAPE_LDAP_FILTER   (0x02)</td> </tr> </table> </div><div class="memdoc"> <p>Apply LDAP filter escaping as per RFC4515. </p> </div> </div> <a class="anchor" id="ga793ae1b187ce490c65eeee2eb59d2831"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_ESCAPE_STRING   (-1)</td> </tr> </table> </div><div class="memdoc"> <p>When passing a string to one of the escape functions, this value can be passed to indicate a string-valued key, and have the length computed automatically. </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga4ebbadaffa33c6aa34e92108c45cd38e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_escape_echo </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>escaped</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>quote</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Escape control characters in a string, as performed by the shell's 'echo' command. Characters are replaced as follows: \a alert (bell), \b backspace, \f form feed, \n new line, \r carriage return, \t horizontal tab, \v vertical tab, \ backslash.</p> <p>Any non ascii character will be encoded as '\xHH', where HH is the hex code of the character.</p> <p>If quote is not zero, the double quote character will also be escaped. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">escaped</td><td>Optional buffer to write the encoded string, can be NULL </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">slen</td><td>The length of the original string, or APR_ESCAPE_STRING </td></tr> <tr><td class="paramname">quote</td><td>If non zero, encode double quotes </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if no changes to the string were detected or the string was NULL </dd></dl> </div> </div> <a class="anchor" id="ga6973ca9a596c8fc9fc34eab647cff11c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_escape_entity </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>escaped</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>toasc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Apply entity encoding to a string. Characters are replaced as follows: '<' becomes '<', '>' becomes '>', '&' becomes '&', the double quote becomes '"" and the single quote becomes '''.</p> <p>If toasc is not zero, any non ascii character will be encoded as '%#ddd;', where ddd is the decimal code of the character. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">escaped</td><td>Optional buffer to write the encoded string, can be NULL </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">slen</td><td>The length of the original string, or APR_ESCAPE_STRING </td></tr> <tr><td class="paramname">toasc</td><td>If non zero, encode non ascii characters </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if no changes to the string were detected or the string was NULL </dd></dl> </div> </div> <a class="anchor" id="gac87b3c2f42fb60f6ea4d8321e60ce69e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_escape_hex </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>dest</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const void * </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t </td> <td class="paramname"><em>srclen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>colon</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convert binary data to a hex encoding. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">dest</td><td>The destination buffer, can be NULL </td></tr> <tr><td class="paramname">src</td><td>The original buffer </td></tr> <tr><td class="paramname">srclen</td><td>The length of the original buffer </td></tr> <tr><td class="paramname">colon</td><td>If not zero, insert colon characters between hex digits. </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if the string was NULL </dd></dl> </div> </div> <a class="anchor" id="ga0c2848e1a814bfae5a619c5650096a65"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_escape_ldap </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>dest</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const void * </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>srclen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>flags</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Apply LDAP escaping to binary data. Characters from RFC4514 and RFC4515 are escaped with their hex equivalents. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">dest</td><td>The destination buffer, can be NULL </td></tr> <tr><td class="paramname">src</td><td>The original buffer </td></tr> <tr><td class="paramname">srclen</td><td>The length of the original buffer </td></tr> <tr><td class="paramname">flags</td><td>APR_ESCAPE_LDAP_DN for RFC4514, APR_ESCAPE_LDAP_FILTER for RFC4515, APR_ESCAPE_LDAP_ALL for both </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if the string was NULL </dd></dl> </div> </div> <a class="anchor" id="gae67859a1d260f354c16e939d24d67058"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_escape_path </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>escaped</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>partial</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Converts an OS path to a URL, in an OS dependent way, as defined in RFC1808. In all cases if a ':' occurs before the first '/' in the URL, the URL should be prefixed with "./" (or the ':' escaped). In the case of Unix, this means leaving '/' alone, but otherwise doing what escape_path_segment() does. For efficiency reasons, we don't use escape_path_segment(), which is provided for reference. Again, RFC 1808 is where this stuff is defined.</p> <p>If partial is set, os_escape_path() assumes that the path will be appended to something with a '/' in it (and thus does not prefix "./"). </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">escaped</td><td>Optional buffer to write the encoded string, can be NULL </td></tr> <tr><td class="paramname">path</td><td>The original string </td></tr> <tr><td class="paramname">slen</td><td>The length of the original string, or APR_ESCAPE_STRING </td></tr> <tr><td class="paramname">partial</td><td>If non zero, suppresses the prepending of "./" </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if no changes to the string were detected or if the string was NULL </dd></dl> </div> </div> <a class="anchor" id="ga2fba5a28f4924f00f1ba9a56bc87f651"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_escape_path_segment </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>escaped</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Escape a path segment, as defined in RFC1808. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">escaped</td><td>Optional buffer to write the encoded string, can be NULL </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">slen</td><td>The length of the original string, or APR_ESCAPE_STRING </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if no changes to the string were detected or the string was NULL </dd></dl> </div> </div> <a class="anchor" id="gafdfca9adc06570fa6efd802e24dce6d1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_escape_shell </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>escaped</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Perform shell escaping on the provided string.</p> <p>Shell escaping causes characters to be prefixed with a '\' character. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">escaped</td><td>Optional buffer to write the encoded string, can be NULL </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">slen</td><td>The length of the original string, or APR_ESCAPE_STRING </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if no changes to the string were detected or the string was NULL </dd></dl> </div> </div> <a class="anchor" id="ga0a2cb4e99758afd5bed8fd62df05e16f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_escape_urlencoded </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>escaped</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Urlencode a string, as defined in <a href="http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1">http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">escaped</td><td>Optional buffer to write the encoded string, can be NULL </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">slen</td><td>The length of the original string, or APR_ESCAPE_STRING </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if no changes to the string were detected or if the stirng was NULL </dd></dl> </div> </div> <a class="anchor" id="ga1265c454e145b9fca52d2feafacd4a02"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_pescape_echo </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>quote</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Escape control characters in a string, as performed by the shell's 'echo' command, and return the results from a pool. Characters are replaced as follows: \a alert (bell), \b backspace, \f form feed, \n new line, \r carriage return, \t horizontal tab, \v vertical tab, \ backslash.</p> <p>Any non ascii character will be encoded as '\xHH', where HH is the hex code of the character.</p> <p>If quote is not zero, the double quote character will also be escaped. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">quote</td><td>If non zero, encode double quotes </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string allocated from the pool on success, the original string if no characters are encoded or the string is NULL. </dd></dl> </div> </div> <a class="anchor" id="gad99b0f505645b63b5f552f5d35f174af"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_pescape_entity </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>toasc</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Apply entity encoding to a string, returning the result from a pool. Characters are replaced as follows: '<' becomes '<', '>' becomes '>', '&' becomes '&', the double quote becomes '"" and the single quote becomes '''. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">toasc</td><td>If non zero, encode non ascii characters </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string allocated from the pool on success, the original string if no characters are encoded or the string is NULL. </dd></dl> </div> </div> <a class="anchor" id="ga2a12cd35230cc148da52ea983da4b211"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_pescape_hex </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const void * </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>colon</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convert binary data to a hex encoding, and return the results from a pool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">src</td><td>The original buffer </td></tr> <tr><td class="paramname">slen</td><td>The length of the original buffer </td></tr> <tr><td class="paramname">colon</td><td>If not zero, insert colon characters between hex digits. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A zero padded buffer allocated from the pool on success, or NULL if src was NULL. </dd></dl> </div> </div> <a class="anchor" id="gaa5f5b60078081ff23d529f0a1063daeb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_pescape_ldap </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const void * </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>flags</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Apply LDAP escaping to binary data, and return the results from a pool. Characters from RFC4514 and RFC4515 are escaped with their hex equivalents. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">src</td><td>The original buffer </td></tr> <tr><td class="paramname">slen</td><td>The length of the original buffer </td></tr> <tr><td class="paramname">flags</td><td>APR_ESCAPE_LDAP_DN for RFC4514, APR_ESCAPE_LDAP_FILTER for RFC4515, APR_ESCAPE_LDAP_ALL for both </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A zero padded buffer allocated from the pool on success, or NULL if src was NULL. </dd></dl> </div> </div> <a class="anchor" id="gacd4fc208448eb07af16350802077783a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_pescape_path </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>partial</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Converts an OS path to a URL, in an OS dependent way, as defined in RFC1808, returning the result from a pool.</p> <p>In all cases if a ':' occurs before the first '/' in the URL, the URL should be prefixed with "./" (or the ':' escaped). In the case of Unix, this means leaving '/' alone, but otherwise doing what escape_path_segment() does. For efficiency reasons, we don't use escape_path_segment(), which is provided for reference. Again, RFC 1808 is where this stuff is defined.</p> <p>If partial is set, os_escape_path() assumes that the path will be appended to something with a '/' in it (and thus does not prefix "./"). </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">partial</td><td>If non zero, suppresses the prepending of "./" </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string allocated from the pool on success, the original string if no characters are encoded or if the string was NULL. </dd></dl> </div> </div> <a class="anchor" id="ga36bd45eb1f919fe61f04f5e9087c6242"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_pescape_path_segment </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Escape a path segment, as defined in RFC1808, returning the result from a pool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">str</td><td>String to be escaped </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string allocated from the pool on success, the original string if no characters are encoded or the string is NULL. </dd></dl> </div> </div> <a class="anchor" id="ga81e97334f8033bfbc3acd5e15262323e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_pescape_shell </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Perform shell escaping on the provided string, returning the result from the pool.</p> <p>Shell escaping causes characters to be prefixed with a '\' character.</p> <p>If no characters were escaped, the original string is returned. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the encoded string, allocated from the pool, or the original string if no escaping took place or the string was NULL. </dd></dl> </div> </div> <a class="anchor" id="ga9caffb30731e3a07a8e23fa6464d35b5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_pescape_urlencoded </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Urlencode a string, as defined in <a href="http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1,">http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1,</a> returning the result from a pool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">str</td><td>String to be escaped </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string allocated from the pool on success, the original string if no characters are encoded or if the string was NULL. </dd></dl> </div> </div> <a class="anchor" id="gabaaeff6e19e92cf1f138b21e87889e05"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_punescape_entity </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Decodes html entities or numeric character references in a string. If the string to be unescaped is syntactically incorrect, then the following fixups will be made: unknown entities will be left undecoded; references to unused numeric characters will be deleted. In particular, &#00; will not be decoded, but will be deleted. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string allocated from the pool on success, the original string if no characters are encoded or the string is NULL. </dd></dl> </div> </div> <a class="anchor" id="ga8cba37bcacb5e1c9440f2b35d44afc49"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const void* apr_punescape_hex </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>colon</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convert hex encoding to binary data, and return the results from a pool. If the colon character appears between pairs of hex digits, it will be ignored. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">colon</td><td>If not zero, ignore colon characters between hex digits. </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the final buffer </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A buffer allocated from the pool on success, or NULL if src was NULL, or a bad character was present. </dd></dl> </div> </div> <a class="anchor" id="gac713d5687a00134cef5c795dbf4e6dbe"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apr_punescape_url </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>url</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>forbid</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>reserved</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>plus</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Unescapes a URL, leaving reserved characters intact, returning the result from a pool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>Pool to allocate from </td></tr> <tr><td class="paramname">url</td><td>String to be unescaped in place </td></tr> <tr><td class="paramname">forbid</td><td>Optional list of forbidden characters, in addition to 0x00 </td></tr> <tr><td class="paramname">reserved</td><td>Optional list of reserved characters that will be left unescaped </td></tr> <tr><td class="paramname">plus</td><td>If non zero, '+' is converted to ' ' as per application/x-www-form-urlencoded encoding </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string allocated from the pool on success, the original string if no characters are decoded, or NULL if a bad escape sequence is found or if a character on the forbid list is found, or if the original string was NULL. </dd></dl> </div> </div> <a class="anchor" id="ga9b835b2da5bf35c33f6c69e8e3100c99"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_unescape_entity </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>unescaped</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Decodes html entities or numeric character references in a string. If the string to be unescaped is syntactically incorrect, then the following fixups will be made: unknown entities will be left undecoded; references to unused numeric characters will be deleted. In particular, &#00; will not be decoded, but will be deleted. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">unescaped</td><td>Optional buffer to write the encoded string, can be NULL </td></tr> <tr><td class="paramname">str</td><td>The original string </td></tr> <tr><td class="paramname">slen</td><td>The length of the original string, or APR_ESCAPE_STRING </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if no changes to the string were detected or the string was NULL </dd></dl> </div> </div> <a class="anchor" id="ga98c3558219d7ce3dd29420c0124ddd73"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_unescape_hex </td> <td>(</td> <td class="paramtype">void * </td> <td class="paramname"><em>dest</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>colon</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convert hex encoded string to binary data. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">dest</td><td>The destination buffer, can be NULL </td></tr> <tr><td class="paramname">str</td><td>The original buffer </td></tr> <tr><td class="paramname">slen</td><td>The length of the original buffer </td></tr> <tr><td class="paramname">colon</td><td>If not zero, ignore colon characters between hex digits. </td></tr> <tr><td class="paramname">len</td><td>If present, returns the length of the string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS, or APR_NOTFOUND if the string was NULL, or APR_BADCH if a non hex character is present. </dd></dl> </div> </div> <a class="anchor" id="ga9a6b08630ef5a605def1dfa4a54b026f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_unescape_url </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>escaped</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>url</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_ssize_t </td> <td class="paramname"><em>slen</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>forbid</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>reserved</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>plus</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_size_t * </td> <td class="paramname"><em>len</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Unescapes a URL, leaving reserved characters intact. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">escaped</td><td>Optional buffer to write the encoded string, can be NULL </td></tr> <tr><td class="paramname">url</td><td>String to be unescaped </td></tr> <tr><td class="paramname">slen</td><td>The length of the original url, or APR_ESCAPE_STRING </td></tr> <tr><td class="paramname">forbid</td><td>Optional list of forbidden characters, in addition to 0x00 </td></tr> <tr><td class="paramname">reserved</td><td>Optional list of reserved characters that will be left unescaped </td></tr> <tr><td class="paramname">plus</td><td>If non zero, '+' is converted to ' ' as per application/x-www-form-urlencoded encoding </td></tr> <tr><td class="paramname">len</td><td>If set, the length of the escaped string will be returned </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS on success, APR_NOTFOUND if no characters are decoded or the string is NULL, APR_EINVAL if a bad escape sequence is found, APR_BADCH if a character on the forbid list is found. </dd></dl> </div> </div> </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.5 </small></address> </body> </html>