| 1 |
<html> |
| 2 |
<head> |
| 3 |
<link rel="stylesheet" type="text/css" href="dox.css" /> |
| 4 |
<title>libapreq2-2.17: include/apreq_param.h File Reference</title> |
| 5 |
</head> |
| 6 |
<body> |
| 7 |
<div id="page-header"> |
| 8 |
<p class="menu"> |
| 9 |
<a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> > |
| 10 |
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p> |
| 11 |
<p class="apache">Apache HTTP Server Request Library</p> |
| 12 |
<img alt="" src="feather.gif" /></div> |
| 13 |
<!-- Generated by Doxygen 1.9.1 --> |
| 14 |
<script type="text/javascript" src="menudata.js"></script> |
| 15 |
<script type="text/javascript" src="menu.js"></script> |
| 16 |
<script type="text/javascript"> |
| 17 |
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 18 |
$(function() { |
| 19 |
initMenu('',false,false,'search.php','Search'); |
| 20 |
}); |
| 21 |
/* @license-end */</script> |
| 22 |
<div id="main-nav"></div> |
| 23 |
<div id="nav-path" class="navpath"> |
| 24 |
<ul> |
| 25 |
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> |
| 26 |
</div> |
| 27 |
</div><!-- top --> |
| 28 |
<div class="header"> |
| 29 |
<div class="summary"> |
| 30 |
<a href="#nested-classes">Data Structures</a> | |
| 31 |
<a href="#typedef-members">Typedefs</a> | |
| 32 |
<a href="#func-members">Functions</a> </div> |
| 33 |
<div class="headertitle"> |
| 34 |
<div class="title">apreq_param.h File Reference<div class="ingroups"><a class="el" href="group__libapreq2.html">Apache Request Library</a></div></div> </div> |
| 35 |
</div><!--header--> |
| 36 |
<div class="contents"> |
| 37 |
|
| 38 |
<p>Request parsing and parameter API. |
| 39 |
<a href="#details">More...</a></p> |
| 40 |
<div class="textblock"><code>#include "<a class="el" href="apreq_8h_source.html">apreq.h</a>"</code><br /> |
| 41 |
<code>#include "apr_buckets.h"</code><br /> |
| 42 |
</div> |
| 43 |
<p><a href="apreq__param_8h_source.html">Go to the source code of this file.</a></p> |
| 44 |
<table class="memberdecls"> |
| 45 |
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| 46 |
Data Structures</h2></td></tr> |
| 47 |
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__param__t.html">apreq_param_t</a></td></tr> |
| 48 |
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| 49 |
</table><table class="memberdecls"> |
| 50 |
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| 51 |
Typedefs</h2></td></tr> |
| 52 |
<tr class="memitem:ad7b3956f0310dec4b970ad7135aeabd7"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structapreq__param__t.html">apreq_param_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#ad7b3956f0310dec4b970ad7135aeabd7">apreq_param_t</a></td></tr> |
| 53 |
<tr class="separator:ad7b3956f0310dec4b970ad7135aeabd7"><td class="memSeparator" colspan="2"> </td></tr> |
| 54 |
</table><table class="memberdecls"> |
| 55 |
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| 56 |
Functions</h2></td></tr> |
| 57 |
<tr class="memitem:af407c2ab726bc8bc34a1b1924a4f327a"><td class="memItemLeft" align="right" valign="top">static APR_INLINE unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#af407c2ab726bc8bc34a1b1924a4f327a">apreq_param_is_tainted</a> (const <a class="el" href="structapreq__param__t.html">apreq_param_t</a> *p)</td></tr> |
| 58 |
<tr class="separator:af407c2ab726bc8bc34a1b1924a4f327a"><td class="memSeparator" colspan="2"> </td></tr> |
| 59 |
<tr class="memitem:a967919466da31283c6d668c58fe5223c"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a967919466da31283c6d668c58fe5223c">apreq_param_tainted_on</a> (<a class="el" href="structapreq__param__t.html">apreq_param_t</a> *p)</td></tr> |
| 60 |
<tr class="separator:a967919466da31283c6d668c58fe5223c"><td class="memSeparator" colspan="2"> </td></tr> |
| 61 |
<tr class="memitem:ae76641d443483db5274624f948e1c347"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#ae76641d443483db5274624f948e1c347">apreq_param_tainted_off</a> (<a class="el" href="structapreq__param__t.html">apreq_param_t</a> *p)</td></tr> |
| 62 |
<tr class="separator:ae76641d443483db5274624f948e1c347"><td class="memSeparator" colspan="2"> </td></tr> |
| 63 |
<tr class="memitem:abe765ec55aebc8409ddd6d3db44ff917"><td class="memItemLeft" align="right" valign="top">static APR_INLINE <a class="el" href="apreq_8h.html#a6607dfa756796989c15014870b48c8cd">apreq_charset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#abe765ec55aebc8409ddd6d3db44ff917">apreq_param_charset_set</a> (<a class="el" href="structapreq__param__t.html">apreq_param_t</a> *p, <a class="el" href="apreq_8h.html#a6607dfa756796989c15014870b48c8cd">apreq_charset_t</a> c)</td></tr> |
| 64 |
<tr class="separator:abe765ec55aebc8409ddd6d3db44ff917"><td class="memSeparator" colspan="2"> </td></tr> |
| 65 |
<tr class="memitem:abe2a7a47df83a5667fe2834bfc03f15a"><td class="memItemLeft" align="right" valign="top">static APR_INLINE <a class="el" href="apreq_8h.html#a6607dfa756796989c15014870b48c8cd">apreq_charset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#abe2a7a47df83a5667fe2834bfc03f15a">apreq_param_charset_get</a> (<a class="el" href="structapreq__param__t.html">apreq_param_t</a> *p)</td></tr> |
| 66 |
<tr class="separator:abe2a7a47df83a5667fe2834bfc03f15a"><td class="memSeparator" colspan="2"> </td></tr> |
| 67 |
<tr class="memitem:a121453693ef7c6af821ae723b6dbe34b"><td class="memItemLeft" align="right" valign="top">static APR_INLINE <a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a121453693ef7c6af821ae723b6dbe34b">apreq_value_to_param</a> (const char *val)</td></tr> |
| 68 |
<tr class="separator:a121453693ef7c6af821ae723b6dbe34b"><td class="memSeparator" colspan="2"> </td></tr> |
| 69 |
<tr class="memitem:a25c915d3d0fd1694d2c538f108646560"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a25c915d3d0fd1694d2c538f108646560">apreq_param_make</a> (apr_pool_t *p, const char *name, const apr_size_t nlen, const char *val, const apr_size_t vlen)</td></tr> |
| 70 |
<tr class="separator:a25c915d3d0fd1694d2c538f108646560"><td class="memSeparator" colspan="2"> </td></tr> |
| 71 |
<tr class="memitem:aeea075c59169992492f6f5c40b9b8a70"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#aeea075c59169992492f6f5c40b9b8a70">apreq_param_decode</a> (<a class="el" href="structapreq__param__t.html">apreq_param_t</a> **param, apr_pool_t *pool, const char *word, apr_size_t nlen, apr_size_t vlen)</td></tr> |
| 72 |
<tr class="separator:aeea075c59169992492f6f5c40b9b8a70"><td class="memSeparator" colspan="2"> </td></tr> |
| 73 |
<tr class="memitem:a4b8b032f9d2ae8e0a6e95b6dd95b5aa9"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a4b8b032f9d2ae8e0a6e95b6dd95b5aa9">apreq_param_encode</a> (apr_pool_t *pool, const <a class="el" href="structapreq__param__t.html">apreq_param_t</a> *param)</td></tr> |
| 74 |
<tr class="separator:a4b8b032f9d2ae8e0a6e95b6dd95b5aa9"><td class="memSeparator" colspan="2"> </td></tr> |
| 75 |
<tr class="memitem:a0aa638519951d85d1faf7bf6ba986226"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a0aa638519951d85d1faf7bf6ba986226">apreq_parse_query_string</a> (apr_pool_t *pool, apr_table_t *t, const char *qs)</td></tr> |
| 76 |
<tr class="separator:a0aa638519951d85d1faf7bf6ba986226"><td class="memSeparator" colspan="2"> </td></tr> |
| 77 |
<tr class="memitem:a76c7e698fd45f3f3e07db60fcba15e52"><td class="memItemLeft" align="right" valign="top">apr_array_header_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a76c7e698fd45f3f3e07db60fcba15e52">apreq_params_as_array</a> (apr_pool_t *p, const apr_table_t *t, const char *key)</td></tr> |
| 78 |
<tr class="separator:a76c7e698fd45f3f3e07db60fcba15e52"><td class="memSeparator" colspan="2"> </td></tr> |
| 79 |
<tr class="memitem:a0f1db12120bb2307f5e33186f094b0d6"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a0f1db12120bb2307f5e33186f094b0d6">apreq_params_as_string</a> (apr_pool_t *p, const apr_table_t *t, const char *key, <a class="el" href="apreq_8h.html#ac3784c04255e92629350505d35b0473e">apreq_join_t</a> mode)</td></tr> |
| 80 |
<tr class="separator:a0f1db12120bb2307f5e33186f094b0d6"><td class="memSeparator" colspan="2"> </td></tr> |
| 81 |
<tr class="memitem:ae449c4a1890767d1e9a50c78ea42769c"><td class="memItemLeft" align="right" valign="top">const apr_table_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#ae449c4a1890767d1e9a50c78ea42769c">apreq_uploads</a> (const apr_table_t *body, apr_pool_t *pool)</td></tr> |
| 82 |
<tr class="separator:ae449c4a1890767d1e9a50c78ea42769c"><td class="memSeparator" colspan="2"> </td></tr> |
| 83 |
<tr class="memitem:a1be07e7c4c8a687203ccc0d38ec3aedd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a1be07e7c4c8a687203ccc0d38ec3aedd">apreq_upload</a> (const apr_table_t *body, const char *name)</td></tr> |
| 84 |
<tr class="separator:a1be07e7c4c8a687203ccc0d38ec3aedd"><td class="memSeparator" colspan="2"> </td></tr> |
| 85 |
</table> |
| 86 |
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 87 |
<div class="textblock"><p>Request parsing and parameter API. </p> |
| 88 |
</div><h2 class="groupheader">Typedef Documentation</h2> |
| 89 |
<a id="ad7b3956f0310dec4b970ad7135aeabd7"></a> |
| 90 |
<h2 class="memtitle"><span class="permalink"><a href="#ad7b3956f0310dec4b970ad7135aeabd7">◆ </a></span>apreq_param_t</h2> |
| 91 |
|
| 92 |
<div class="memitem"> |
| 93 |
<div class="memproto"> |
| 94 |
<table class="memname"> |
| 95 |
<tr> |
| 96 |
<td class="memname">typedef struct <a class="el" href="structapreq__param__t.html">apreq_param_t</a> <a class="el" href="structapreq__param__t.html">apreq_param_t</a></td> |
| 97 |
</tr> |
| 98 |
</table> |
| 99 |
</div><div class="memdoc"> |
| 100 |
<p>Common data structure for params and file uploads </p> |
| 101 |
|
| 102 |
</div> |
| 103 |
</div> |
| 104 |
<h2 class="groupheader">Function Documentation</h2> |
| 105 |
<a id="abe2a7a47df83a5667fe2834bfc03f15a"></a> |
| 106 |
<h2 class="memtitle"><span class="permalink"><a href="#abe2a7a47df83a5667fe2834bfc03f15a">◆ </a></span>apreq_param_charset_get()</h2> |
| 107 |
|
| 108 |
<div class="memitem"> |
| 109 |
<div class="memproto"> |
| 110 |
<table class="mlabels"> |
| 111 |
<tr> |
| 112 |
<td class="mlabels-left"> |
| 113 |
<table class="memname"> |
| 114 |
<tr> |
| 115 |
<td class="memname">static APR_INLINE <a class="el" href="apreq_8h.html#a6607dfa756796989c15014870b48c8cd">apreq_charset_t</a> apreq_param_charset_get </td> |
| 116 |
<td>(</td> |
| 117 |
<td class="paramtype"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td> |
| 118 |
<td class="paramname"><em>p</em></td><td>)</td> |
| 119 |
<td></td> |
| 120 |
</tr> |
| 121 |
</table> |
| 122 |
</td> |
| 123 |
<td class="mlabels-right"> |
| 124 |
<span class="mlabels"><span class="mlabel">static</span></span> </td> |
| 125 |
</tr> |
| 126 |
</table> |
| 127 |
</div><div class="memdoc"> |
| 128 |
<p>Gets the character encoding for this parameter. </p> |
| 129 |
|
| 130 |
</div> |
| 131 |
</div> |
| 132 |
<a id="abe765ec55aebc8409ddd6d3db44ff917"></a> |
| 133 |
<h2 class="memtitle"><span class="permalink"><a href="#abe765ec55aebc8409ddd6d3db44ff917">◆ </a></span>apreq_param_charset_set()</h2> |
| 134 |
|
| 135 |
<div class="memitem"> |
| 136 |
<div class="memproto"> |
| 137 |
<table class="mlabels"> |
| 138 |
<tr> |
| 139 |
<td class="mlabels-left"> |
| 140 |
<table class="memname"> |
| 141 |
<tr> |
| 142 |
<td class="memname">static APR_INLINE <a class="el" href="apreq_8h.html#a6607dfa756796989c15014870b48c8cd">apreq_charset_t</a> apreq_param_charset_set </td> |
| 143 |
<td>(</td> |
| 144 |
<td class="paramtype"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td> |
| 145 |
<td class="paramname"><em>p</em>, </td> |
| 146 |
</tr> |
| 147 |
<tr> |
| 148 |
<td class="paramkey"></td> |
| 149 |
<td></td> |
| 150 |
<td class="paramtype"><a class="el" href="apreq_8h.html#a6607dfa756796989c15014870b48c8cd">apreq_charset_t</a> </td> |
| 151 |
<td class="paramname"><em>c</em> </td> |
| 152 |
</tr> |
| 153 |
<tr> |
| 154 |
<td></td> |
| 155 |
<td>)</td> |
| 156 |
<td></td><td></td> |
| 157 |
</tr> |
| 158 |
</table> |
| 159 |
</td> |
| 160 |
<td class="mlabels-right"> |
| 161 |
<span class="mlabels"><span class="mlabel">static</span></span> </td> |
| 162 |
</tr> |
| 163 |
</table> |
| 164 |
</div><div class="memdoc"> |
| 165 |
<p>Sets the character encoding for this parameter. </p> |
| 166 |
|
| 167 |
</div> |
| 168 |
</div> |
| 169 |
<a id="aeea075c59169992492f6f5c40b9b8a70"></a> |
| 170 |
<h2 class="memtitle"><span class="permalink"><a href="#aeea075c59169992492f6f5c40b9b8a70">◆ </a></span>apreq_param_decode()</h2> |
| 171 |
|
| 172 |
<div class="memitem"> |
| 173 |
<div class="memproto"> |
| 174 |
<table class="memname"> |
| 175 |
<tr> |
| 176 |
<td class="memname">apr_status_t apreq_param_decode </td> |
| 177 |
<td>(</td> |
| 178 |
<td class="paramtype"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> ** </td> |
| 179 |
<td class="paramname"><em>param</em>, </td> |
| 180 |
</tr> |
| 181 |
<tr> |
| 182 |
<td class="paramkey"></td> |
| 183 |
<td></td> |
| 184 |
<td class="paramtype">apr_pool_t * </td> |
| 185 |
<td class="paramname"><em>pool</em>, </td> |
| 186 |
</tr> |
| 187 |
<tr> |
| 188 |
<td class="paramkey"></td> |
| 189 |
<td></td> |
| 190 |
<td class="paramtype">const char * </td> |
| 191 |
<td class="paramname"><em>word</em>, </td> |
| 192 |
</tr> |
| 193 |
<tr> |
| 194 |
<td class="paramkey"></td> |
| 195 |
<td></td> |
| 196 |
<td class="paramtype">apr_size_t </td> |
| 197 |
<td class="paramname"><em>nlen</em>, </td> |
| 198 |
</tr> |
| 199 |
<tr> |
| 200 |
<td class="paramkey"></td> |
| 201 |
<td></td> |
| 202 |
<td class="paramtype">apr_size_t </td> |
| 203 |
<td class="paramname"><em>vlen</em> </td> |
| 204 |
</tr> |
| 205 |
<tr> |
| 206 |
<td></td> |
| 207 |
<td>)</td> |
| 208 |
<td></td><td></td> |
| 209 |
</tr> |
| 210 |
</table> |
| 211 |
</div><div class="memdoc"> |
| 212 |
<p>Url-decodes a name=value pair into a param.</p> |
| 213 |
<dl class="params"><dt>Parameters</dt><dd> |
| 214 |
<table class="params"> |
| 215 |
<tr><td class="paramname">param</td><td>points to the decoded parameter on success </td></tr> |
| 216 |
<tr><td class="paramname">pool</td><td>Pool from which the param is allocated. </td></tr> |
| 217 |
<tr><td class="paramname">word</td><td>Start of the name=value pair. </td></tr> |
| 218 |
<tr><td class="paramname">nlen</td><td>Length of urlencoded name. </td></tr> |
| 219 |
<tr><td class="paramname">vlen</td><td>Length of urlencoded value.</td></tr> |
| 220 |
</table> |
| 221 |
</dd> |
| 222 |
</dl> |
| 223 |
<dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS on success. </dd> |
| 224 |
<dd> |
| 225 |
<a class="el" href="apreq__error_8h.html#a73a69e21acc2cf849310a421ab43d2ba">APREQ_ERROR_BADSEQ</a> or <a class="el" href="apreq__error_8h.html#a04b6a01738a1ee7fd1ecc79d256e721f">APREQ_ERROR_BADCHAR</a> on malformed input.</dd></dl> |
| 226 |
<dl class="section remark"><dt>Remarks</dt><dd>Unless vlen == 0, this function assumes there is exactly one character ('=') which separates the pair. </dd></dl> |
| 227 |
|
| 228 |
</div> |
| 229 |
</div> |
| 230 |
<a id="a4b8b032f9d2ae8e0a6e95b6dd95b5aa9"></a> |
| 231 |
<h2 class="memtitle"><span class="permalink"><a href="#a4b8b032f9d2ae8e0a6e95b6dd95b5aa9">◆ </a></span>apreq_param_encode()</h2> |
| 232 |
|
| 233 |
<div class="memitem"> |
| 234 |
<div class="memproto"> |
| 235 |
<table class="memname"> |
| 236 |
<tr> |
| 237 |
<td class="memname">char* apreq_param_encode </td> |
| 238 |
<td>(</td> |
| 239 |
<td class="paramtype">apr_pool_t * </td> |
| 240 |
<td class="paramname"><em>pool</em>, </td> |
| 241 |
</tr> |
| 242 |
<tr> |
| 243 |
<td class="paramkey"></td> |
| 244 |
<td></td> |
| 245 |
<td class="paramtype">const <a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td> |
| 246 |
<td class="paramname"><em>param</em> </td> |
| 247 |
</tr> |
| 248 |
<tr> |
| 249 |
<td></td> |
| 250 |
<td>)</td> |
| 251 |
<td></td><td></td> |
| 252 |
</tr> |
| 253 |
</table> |
| 254 |
</div><div class="memdoc"> |
| 255 |
<p>Url-encodes the param into a name-value pair. </p><dl class="params"><dt>Parameters</dt><dd> |
| 256 |
<table class="params"> |
| 257 |
<tr><td class="paramname">pool</td><td>Pool which allocates the returned string. </td></tr> |
| 258 |
<tr><td class="paramname">param</td><td>Param to encode. </td></tr> |
| 259 |
</table> |
| 260 |
</dd> |
| 261 |
</dl> |
| 262 |
<dl class="section return"><dt>Returns</dt><dd>name-value pair representing the param. </dd></dl> |
| 263 |
|
| 264 |
</div> |
| 265 |
</div> |
| 266 |
<a id="af407c2ab726bc8bc34a1b1924a4f327a"></a> |
| 267 |
<h2 class="memtitle"><span class="permalink"><a href="#af407c2ab726bc8bc34a1b1924a4f327a">◆ </a></span>apreq_param_is_tainted()</h2> |
| 268 |
|
| 269 |
<div class="memitem"> |
| 270 |
<div class="memproto"> |
| 271 |
<table class="mlabels"> |
| 272 |
<tr> |
| 273 |
<td class="mlabels-left"> |
| 274 |
<table class="memname"> |
| 275 |
<tr> |
| 276 |
<td class="memname">static APR_INLINE unsigned apreq_param_is_tainted </td> |
| 277 |
<td>(</td> |
| 278 |
<td class="paramtype">const <a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td> |
| 279 |
<td class="paramname"><em>p</em></td><td>)</td> |
| 280 |
<td></td> |
| 281 |
</tr> |
| 282 |
</table> |
| 283 |
</td> |
| 284 |
<td class="mlabels-right"> |
| 285 |
<span class="mlabels"><span class="mlabel">static</span></span> </td> |
| 286 |
</tr> |
| 287 |
</table> |
| 288 |
</div><div class="memdoc"> |
| 289 |
<dl class="section return"><dt>Returns</dt><dd>1 if the taint flag is set, 0 otherwise. </dd></dl> |
| 290 |
|
| 291 |
</div> |
| 292 |
</div> |
| 293 |
<a id="a25c915d3d0fd1694d2c538f108646560"></a> |
| 294 |
<h2 class="memtitle"><span class="permalink"><a href="#a25c915d3d0fd1694d2c538f108646560">◆ </a></span>apreq_param_make()</h2> |
| 295 |
|
| 296 |
<div class="memitem"> |
| 297 |
<div class="memproto"> |
| 298 |
<table class="memname"> |
| 299 |
<tr> |
| 300 |
<td class="memname"><a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_param_make </td> |
| 301 |
<td>(</td> |
| 302 |
<td class="paramtype">apr_pool_t * </td> |
| 303 |
<td class="paramname"><em>p</em>, </td> |
| 304 |
</tr> |
| 305 |
<tr> |
| 306 |
<td class="paramkey"></td> |
| 307 |
<td></td> |
| 308 |
<td class="paramtype">const char * </td> |
| 309 |
<td class="paramname"><em>name</em>, </td> |
| 310 |
</tr> |
| 311 |
<tr> |
| 312 |
<td class="paramkey"></td> |
| 313 |
<td></td> |
| 314 |
<td class="paramtype">const apr_size_t </td> |
| 315 |
<td class="paramname"><em>nlen</em>, </td> |
| 316 |
</tr> |
| 317 |
<tr> |
| 318 |
<td class="paramkey"></td> |
| 319 |
<td></td> |
| 320 |
<td class="paramtype">const char * </td> |
| 321 |
<td class="paramname"><em>val</em>, </td> |
| 322 |
</tr> |
| 323 |
<tr> |
| 324 |
<td class="paramkey"></td> |
| 325 |
<td></td> |
| 326 |
<td class="paramtype">const apr_size_t </td> |
| 327 |
<td class="paramname"><em>vlen</em> </td> |
| 328 |
</tr> |
| 329 |
<tr> |
| 330 |
<td></td> |
| 331 |
<td>)</td> |
| 332 |
<td></td><td></td> |
| 333 |
</tr> |
| 334 |
</table> |
| 335 |
</div><div class="memdoc"> |
| 336 |
<p>creates a param from name/value information </p> |
| 337 |
|
| 338 |
</div> |
| 339 |
</div> |
| 340 |
<a id="ae76641d443483db5274624f948e1c347"></a> |
| 341 |
<h2 class="memtitle"><span class="permalink"><a href="#ae76641d443483db5274624f948e1c347">◆ </a></span>apreq_param_tainted_off()</h2> |
| 342 |
|
| 343 |
<div class="memitem"> |
| 344 |
<div class="memproto"> |
| 345 |
<table class="mlabels"> |
| 346 |
<tr> |
| 347 |
<td class="mlabels-left"> |
| 348 |
<table class="memname"> |
| 349 |
<tr> |
| 350 |
<td class="memname">static APR_INLINE void apreq_param_tainted_off </td> |
| 351 |
<td>(</td> |
| 352 |
<td class="paramtype"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td> |
| 353 |
<td class="paramname"><em>p</em></td><td>)</td> |
| 354 |
<td></td> |
| 355 |
</tr> |
| 356 |
</table> |
| 357 |
</td> |
| 358 |
<td class="mlabels-right"> |
| 359 |
<span class="mlabels"><span class="mlabel">static</span></span> </td> |
| 360 |
</tr> |
| 361 |
</table> |
| 362 |
</div><div class="memdoc"> |
| 363 |
<p>Turns off the taint flag. </p> |
| 364 |
|
| 365 |
</div> |
| 366 |
</div> |
| 367 |
<a id="a967919466da31283c6d668c58fe5223c"></a> |
| 368 |
<h2 class="memtitle"><span class="permalink"><a href="#a967919466da31283c6d668c58fe5223c">◆ </a></span>apreq_param_tainted_on()</h2> |
| 369 |
|
| 370 |
<div class="memitem"> |
| 371 |
<div class="memproto"> |
| 372 |
<table class="mlabels"> |
| 373 |
<tr> |
| 374 |
<td class="mlabels-left"> |
| 375 |
<table class="memname"> |
| 376 |
<tr> |
| 377 |
<td class="memname">static APR_INLINE void apreq_param_tainted_on </td> |
| 378 |
<td>(</td> |
| 379 |
<td class="paramtype"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td> |
| 380 |
<td class="paramname"><em>p</em></td><td>)</td> |
| 381 |
<td></td> |
| 382 |
</tr> |
| 383 |
</table> |
| 384 |
</td> |
| 385 |
<td class="mlabels-right"> |
| 386 |
<span class="mlabels"><span class="mlabel">static</span></span> </td> |
| 387 |
</tr> |
| 388 |
</table> |
| 389 |
</div><div class="memdoc"> |
| 390 |
<p>Sets the tainted flag. </p> |
| 391 |
|
| 392 |
</div> |
| 393 |
</div> |
| 394 |
<a id="a76c7e698fd45f3f3e07db60fcba15e52"></a> |
| 395 |
<h2 class="memtitle"><span class="permalink"><a href="#a76c7e698fd45f3f3e07db60fcba15e52">◆ </a></span>apreq_params_as_array()</h2> |
| 396 |
|
| 397 |
<div class="memitem"> |
| 398 |
<div class="memproto"> |
| 399 |
<table class="memname"> |
| 400 |
<tr> |
| 401 |
<td class="memname">apr_array_header_t* apreq_params_as_array </td> |
| 402 |
<td>(</td> |
| 403 |
<td class="paramtype">apr_pool_t * </td> |
| 404 |
<td class="paramname"><em>p</em>, </td> |
| 405 |
</tr> |
| 406 |
<tr> |
| 407 |
<td class="paramkey"></td> |
| 408 |
<td></td> |
| 409 |
<td class="paramtype">const apr_table_t * </td> |
| 410 |
<td class="paramname"><em>t</em>, </td> |
| 411 |
</tr> |
| 412 |
<tr> |
| 413 |
<td class="paramkey"></td> |
| 414 |
<td></td> |
| 415 |
<td class="paramtype">const char * </td> |
| 416 |
<td class="paramname"><em>key</em> </td> |
| 417 |
</tr> |
| 418 |
<tr> |
| 419 |
<td></td> |
| 420 |
<td>)</td> |
| 421 |
<td></td><td></td> |
| 422 |
</tr> |
| 423 |
</table> |
| 424 |
</div><div class="memdoc"> |
| 425 |
<p>Returns an array of parameters (<a class="el" href="structapreq__param__t.html">apreq_param_t</a> *) matching the given key. The key is case-insensitive. </p><dl class="params"><dt>Parameters</dt><dd> |
| 426 |
<table class="params"> |
| 427 |
<tr><td class="paramname">p</td><td>Allocates the returned array. </td></tr> |
| 428 |
<tr><td class="paramname">t</td><td>the parameter table returned by <a class="el" href="apreq__module_8h.html#ade74830e449fa5bb24694ffc3b8374ca">apreq_args()</a>, <a class="el" href="apreq__module_8h.html#ae928689622d094025a8efb8c6c17d680">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a0dff48fd4e83399a07853abe9d67c251">apreq_params()</a> </td></tr> |
| 429 |
<tr><td class="paramname">key</td><td>Null-terminated search key, case insensitive. key==NULL fetches all parameters. </td></tr> |
| 430 |
</table> |
| 431 |
</dd> |
| 432 |
</dl> |
| 433 |
<dl class="section return"><dt>Returns</dt><dd>an array of apreq_param_t* (pointers) </dd></dl> |
| 434 |
<dl class="section remark"><dt>Remarks</dt><dd>Also parses the request if necessary. </dd></dl> |
| 435 |
|
| 436 |
</div> |
| 437 |
</div> |
| 438 |
<a id="a0f1db12120bb2307f5e33186f094b0d6"></a> |
| 439 |
<h2 class="memtitle"><span class="permalink"><a href="#a0f1db12120bb2307f5e33186f094b0d6">◆ </a></span>apreq_params_as_string()</h2> |
| 440 |
|
| 441 |
<div class="memitem"> |
| 442 |
<div class="memproto"> |
| 443 |
<table class="memname"> |
| 444 |
<tr> |
| 445 |
<td class="memname">const char* apreq_params_as_string </td> |
| 446 |
<td>(</td> |
| 447 |
<td class="paramtype">apr_pool_t * </td> |
| 448 |
<td class="paramname"><em>p</em>, </td> |
| 449 |
</tr> |
| 450 |
<tr> |
| 451 |
<td class="paramkey"></td> |
| 452 |
<td></td> |
| 453 |
<td class="paramtype">const apr_table_t * </td> |
| 454 |
<td class="paramname"><em>t</em>, </td> |
| 455 |
</tr> |
| 456 |
<tr> |
| 457 |
<td class="paramkey"></td> |
| 458 |
<td></td> |
| 459 |
<td class="paramtype">const char * </td> |
| 460 |
<td class="paramname"><em>key</em>, </td> |
| 461 |
</tr> |
| 462 |
<tr> |
| 463 |
<td class="paramkey"></td> |
| 464 |
<td></td> |
| 465 |
<td class="paramtype"><a class="el" href="apreq_8h.html#ac3784c04255e92629350505d35b0473e">apreq_join_t</a> </td> |
| 466 |
<td class="paramname"><em>mode</em> </td> |
| 467 |
</tr> |
| 468 |
<tr> |
| 469 |
<td></td> |
| 470 |
<td>)</td> |
| 471 |
<td></td><td></td> |
| 472 |
</tr> |
| 473 |
</table> |
| 474 |
</div><div class="memdoc"> |
| 475 |
<p>Returns a ", " -joined string containing all parameters for the requested key, an empty string if none are found. The key is case-insensitive.</p> |
| 476 |
<dl class="params"><dt>Parameters</dt><dd> |
| 477 |
<table class="params"> |
| 478 |
<tr><td class="paramname">p</td><td>Allocates the return string. </td></tr> |
| 479 |
<tr><td class="paramname">t</td><td>the parameter table returned by <a class="el" href="apreq__module_8h.html#ade74830e449fa5bb24694ffc3b8374ca">apreq_args()</a>, <a class="el" href="apreq__module_8h.html#ae928689622d094025a8efb8c6c17d680">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a0dff48fd4e83399a07853abe9d67c251">apreq_params()</a> </td></tr> |
| 480 |
<tr><td class="paramname">key</td><td>Null-terminated parameter name, case insensitive. key==NULL fetches all values. </td></tr> |
| 481 |
<tr><td class="paramname">mode</td><td>Join type- see <a class="el" href="apreq__util_8h.html#a1aa668dc806fce4bd0fef348d1601930">apreq_join()</a>. </td></tr> |
| 482 |
</table> |
| 483 |
</dd> |
| 484 |
</dl> |
| 485 |
<dl class="section return"><dt>Returns</dt><dd>the joined string or NULL on error </dd></dl> |
| 486 |
<dl class="section remark"><dt>Remarks</dt><dd>Also parses the request if necessary. </dd></dl> |
| 487 |
|
| 488 |
</div> |
| 489 |
</div> |
| 490 |
<a id="a0aa638519951d85d1faf7bf6ba986226"></a> |
| 491 |
<h2 class="memtitle"><span class="permalink"><a href="#a0aa638519951d85d1faf7bf6ba986226">◆ </a></span>apreq_parse_query_string()</h2> |
| 492 |
|
| 493 |
<div class="memitem"> |
| 494 |
<div class="memproto"> |
| 495 |
<table class="memname"> |
| 496 |
<tr> |
| 497 |
<td class="memname">apr_status_t apreq_parse_query_string </td> |
| 498 |
<td>(</td> |
| 499 |
<td class="paramtype">apr_pool_t * </td> |
| 500 |
<td class="paramname"><em>pool</em>, </td> |
| 501 |
</tr> |
| 502 |
<tr> |
| 503 |
<td class="paramkey"></td> |
| 504 |
<td></td> |
| 505 |
<td class="paramtype">apr_table_t * </td> |
| 506 |
<td class="paramname"><em>t</em>, </td> |
| 507 |
</tr> |
| 508 |
<tr> |
| 509 |
<td class="paramkey"></td> |
| 510 |
<td></td> |
| 511 |
<td class="paramtype">const char * </td> |
| 512 |
<td class="paramname"><em>qs</em> </td> |
| 513 |
</tr> |
| 514 |
<tr> |
| 515 |
<td></td> |
| 516 |
<td>)</td> |
| 517 |
<td></td><td></td> |
| 518 |
</tr> |
| 519 |
</table> |
| 520 |
</div><div class="memdoc"> |
| 521 |
<p>Parse a url-encoded string into a param table. </p><dl class="params"><dt>Parameters</dt><dd> |
| 522 |
<table class="params"> |
| 523 |
<tr><td class="paramname">pool</td><td>pool used to allocate the param data. </td></tr> |
| 524 |
<tr><td class="paramname">t</td><td>table to which the params are added. </td></tr> |
| 525 |
<tr><td class="paramname">qs</td><td>Query string to url-decode. </td></tr> |
| 526 |
</table> |
| 527 |
</dd> |
| 528 |
</dl> |
| 529 |
<dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS if successful, error otherwise. </dd></dl> |
| 530 |
<dl class="section remark"><dt>Remarks</dt><dd>This function uses [&;] as the set of tokens to delineate words, and will treat a word w/o '=' as a name-value pair with value-length = 0. </dd></dl> |
| 531 |
|
| 532 |
</div> |
| 533 |
</div> |
| 534 |
<a id="a1be07e7c4c8a687203ccc0d38ec3aedd"></a> |
| 535 |
<h2 class="memtitle"><span class="permalink"><a href="#a1be07e7c4c8a687203ccc0d38ec3aedd">◆ </a></span>apreq_upload()</h2> |
| 536 |
|
| 537 |
<div class="memitem"> |
| 538 |
<div class="memproto"> |
| 539 |
<table class="memname"> |
| 540 |
<tr> |
| 541 |
<td class="memname">const <a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_upload </td> |
| 542 |
<td>(</td> |
| 543 |
<td class="paramtype">const apr_table_t * </td> |
| 544 |
<td class="paramname"><em>body</em>, </td> |
| 545 |
</tr> |
| 546 |
<tr> |
| 547 |
<td class="paramkey"></td> |
| 548 |
<td></td> |
| 549 |
<td class="paramtype">const char * </td> |
| 550 |
<td class="paramname"><em>name</em> </td> |
| 551 |
</tr> |
| 552 |
<tr> |
| 553 |
<td></td> |
| 554 |
<td>)</td> |
| 555 |
<td></td><td></td> |
| 556 |
</tr> |
| 557 |
</table> |
| 558 |
</div><div class="memdoc"> |
| 559 |
<p>Returns the first param in req->body which has both param->v.name matching key (case insensitive) and param->upload != NULL. </p><dl class="params"><dt>Parameters</dt><dd> |
| 560 |
<table class="params"> |
| 561 |
<tr><td class="paramname">body</td><td>parameter table returned by <a class="el" href="apreq__module_8h.html#ae928689622d094025a8efb8c6c17d680">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a0dff48fd4e83399a07853abe9d67c251">apreq_params()</a> </td></tr> |
| 562 |
<tr><td class="paramname">name</td><td>Parameter name. key == NULL returns first upload. </td></tr> |
| 563 |
</table> |
| 564 |
</dd> |
| 565 |
</dl> |
| 566 |
<dl class="section return"><dt>Returns</dt><dd>Corresponding upload, NULL if none found. </dd></dl> |
| 567 |
<dl class="section remark"><dt>Remarks</dt><dd>Will parse the request as necessary. </dd></dl> |
| 568 |
|
| 569 |
</div> |
| 570 |
</div> |
| 571 |
<a id="ae449c4a1890767d1e9a50c78ea42769c"></a> |
| 572 |
<h2 class="memtitle"><span class="permalink"><a href="#ae449c4a1890767d1e9a50c78ea42769c">◆ </a></span>apreq_uploads()</h2> |
| 573 |
|
| 574 |
<div class="memitem"> |
| 575 |
<div class="memproto"> |
| 576 |
<table class="memname"> |
| 577 |
<tr> |
| 578 |
<td class="memname">const apr_table_t* apreq_uploads </td> |
| 579 |
<td>(</td> |
| 580 |
<td class="paramtype">const apr_table_t * </td> |
| 581 |
<td class="paramname"><em>body</em>, </td> |
| 582 |
</tr> |
| 583 |
<tr> |
| 584 |
<td class="paramkey"></td> |
| 585 |
<td></td> |
| 586 |
<td class="paramtype">apr_pool_t * </td> |
| 587 |
<td class="paramname"><em>pool</em> </td> |
| 588 |
</tr> |
| 589 |
<tr> |
| 590 |
<td></td> |
| 591 |
<td>)</td> |
| 592 |
<td></td><td></td> |
| 593 |
</tr> |
| 594 |
</table> |
| 595 |
</div><div class="memdoc"> |
| 596 |
<p>Returns a table of all params in req->body with non-NULL upload brigades. </p><dl class="params"><dt>Parameters</dt><dd> |
| 597 |
<table class="params"> |
| 598 |
<tr><td class="paramname">body</td><td>parameter table returned by <a class="el" href="apreq__module_8h.html#ae928689622d094025a8efb8c6c17d680">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a0dff48fd4e83399a07853abe9d67c251">apreq_params()</a> </td></tr> |
| 599 |
<tr><td class="paramname">pool</td><td>Pool which allocates the table struct. </td></tr> |
| 600 |
</table> |
| 601 |
</dd> |
| 602 |
</dl> |
| 603 |
<dl class="section return"><dt>Returns</dt><dd>Upload table. </dd></dl> |
| 604 |
<dl class="section remark"><dt>Remarks</dt><dd>Will parse the request if necessary. </dd></dl> |
| 605 |
|
| 606 |
</div> |
| 607 |
</div> |
| 608 |
<a id="a121453693ef7c6af821ae723b6dbe34b"></a> |
| 609 |
<h2 class="memtitle"><span class="permalink"><a href="#a121453693ef7c6af821ae723b6dbe34b">◆ </a></span>apreq_value_to_param()</h2> |
| 610 |
|
| 611 |
<div class="memitem"> |
| 612 |
<div class="memproto"> |
| 613 |
<table class="mlabels"> |
| 614 |
<tr> |
| 615 |
<td class="mlabels-left"> |
| 616 |
<table class="memname"> |
| 617 |
<tr> |
| 618 |
<td class="memname">static APR_INLINE <a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_value_to_param </td> |
| 619 |
<td>(</td> |
| 620 |
<td class="paramtype">const char * </td> |
| 621 |
<td class="paramname"><em>val</em></td><td>)</td> |
| 622 |
<td></td> |
| 623 |
</tr> |
| 624 |
</table> |
| 625 |
</td> |
| 626 |
<td class="mlabels-right"> |
| 627 |
<span class="mlabels"><span class="mlabel">static</span></span> </td> |
| 628 |
</tr> |
| 629 |
</table> |
| 630 |
</div><div class="memdoc"> |
| 631 |
<p>Upgrades args and body table values to <a class="el" href="structapreq__param__t.html">apreq_param_t</a> structs. </p> |
| 632 |
|
| 633 |
</div> |
| 634 |
</div> |
| 635 |
</div><!-- contents --> |
| 636 |
<div id="footer"> |
| 637 |
<p class="apache"> |
| 638 |
Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/> |
| 639 |
See <a href="apreq_license.html">LICENSE</a>.</p> |
| 640 |
<p class="menu"> |
| 641 |
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a> |
| 642 |
version 1.9.1 on Thu Aug 18 2022</span> |
| 643 |
</p> |
| 644 |
</div> |
| 645 |
</body> |
| 646 |
</html> |