<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Request params</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Request params<br>
<small>
[<a class="el" href="group__LIBRARY.html">libapreq2</a>]</small>
</h1><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structapreq__param__t.html">apreq_param_t</a></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structapreq__request__t.html">apreq_request_t</a></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__params.html#a13">apreq_value_to_param</a>(ptr) apreq_attr_to_type(<a class="el" href="structapreq__param__t.html">apreq_param_t</a>, v, ptr)</td></tr>
<tr><td nowrap align=right valign=top><a name="a14" doxytag="params::apreq_param_name"></a>
#define </td><td valign=bottom><b>apreq_param_name</b>(p) ((p)->v.name)</td></tr>
<tr><td nowrap align=right valign=top><a name="a15" doxytag="params::apreq_param_value"></a>
#define </td><td valign=bottom><b>apreq_param_value</b>(p) ((p)->v.data)</td></tr>
<tr><td nowrap align=right valign=top><a name="a16" doxytag="params::apreq_param_info"></a>
#define </td><td valign=bottom><b>apreq_param_info</b>(p) ((p)->info)</td></tr>
<tr><td nowrap align=right valign=top><a name="a17" doxytag="params::apreq_param_status"></a>
#define </td><td valign=bottom><b>apreq_param_status</b>(p) ((p)->v.status)</td></tr>
<tr><td nowrap align=right valign=top><a name="a18" doxytag="params::apreq_param_brigade"></a>
#define </td><td valign=bottom><b>apreq_param_brigade</b>(p) ((p)->bb ? apreq_copy_brigade((p)->bb) : NULL)</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__params.html#a19">apreq_params_as_string</a>(req, key, pool, mode) apreq_join(pool, ", ", apreq_params(req,pool,key), mode)</td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef apreq_param_t </td><td valign=bottom><a class="el" href="group__params.html#a0">apreq_param_t</a></td></tr>
<tr><td nowrap align=right valign=top>typedef apreq_request_t </td><td valign=bottom><a class="el" href="group__params.html#a1">apreq_request_t</a></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structapreq__request__t.html">apreq_request_t</a> * </td><td valign=bottom><a class="el" href="group__params.html#a3">apreq_request</a> (void *env, const char *qs)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td><td valign=bottom><a class="el" href="group__params.html#a4">apreq_param</a> (const <a class="el" href="structapreq__request__t.html">apreq_request_t</a> *req, const char *name)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td><td valign=bottom><a class="el" href="group__params.html#a11">apreq_upload</a> (const <a class="el" href="structapreq__request__t.html">apreq_request_t</a> *req, const char *key)</td></tr>
<tr><td nowrap align=right valign=top><a name="a12" doxytag="params::apreq_request_config"></a>
</table>
<hr><h2>Define Documentation</h2>
<a name="a19" doxytag="apreq_params.h::apreq_params_as_string"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define apreq_params_as_string</td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">req, <tr>
<td></td>
<td></td>
<td class="md" nowrap>key, <tr>
<td></td>
<td></td>
<td class="md" nowrap>pool, <tr>
<td></td>
<td></td>
<td class="md" nowrap>mode </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> apreq_join(pool, ", ", apreq_params(req,pool,key), mode)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a ", " -separated string containing all parameters for the requested key, NULL if none found. The key is case-insensitive. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>req</em> </td><td>The current <a class="el" href="structapreq__request__t.html">apreq_request_t</a> object. </td></tr>
<tr><td valign=top><em>key</em> </td><td>Nul-terminated search key. Returns the first table value if NULL. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Also parses the request as necessary. </dd></dl>
</td>
</tr>
</table>
<a name="a13" doxytag="apreq_params.h::apreq_value_to_param"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define apreq_value_to_param</td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">ptr </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> apreq_attr_to_type(<a class="el" href="structapreq__param__t.html">apreq_param_t</a>, v, ptr)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
accessor macros </td>
</tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a name="a0" doxytag="apreq_params.h::apreq_param_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef struct apreq_param_t apreq_param_t
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Common data structure for params and file uploads </td>
</tr>
</table>
<a name="a1" doxytag="apreq_params.h::apreq_request_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef struct apreq_request_t apreq_request_t
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Structure which manages the request data. </td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a6" doxytag="apreq_params.c::apreq_decode_param"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_decode_param </td>
<td class="md" valign="top">( </td>
<td class="mdname" nowrap> <em>pool</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>word</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="mdname" nowrap> <em>nlen</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="mdname" nowrap> <em>vlen</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Url-decodes a name=value pair into a param. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pool</em> </td><td>Pool from which the param is allocated. </td></tr>
<tr><td valign=top><em>word</em> </td><td>Start of the name=value pair. </td></tr>
<tr><td valign=top><em>nlen</em> </td><td>Length of urlencoded name. </td></tr>
<tr><td valign=top><em>vlen</em> </td><td>Length of urlencoded value. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Unless vlen == 0, this function assumes there is exactly one character ('=') which separates the pair. </dd></dl>
</td>
</tr>
</table>
<a name="a7" doxytag="apreq_params.c::apreq_encode_param"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* apreq_encode_param </td>
<td class="md" valign="top">( </td>
<td class="mdname" nowrap> <em>pool</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td>
<td class="mdname" nowrap> <em>param</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Url-encodes the param into a name-value pair. </td>
</tr>
</table>
<a name="a2" doxytag="apreq_params.c::apreq_make_param"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_make_param </td>
<td class="md" valign="top">( </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="mdname" nowrap> <em>nlen</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>val</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="mdname" nowrap> <em>vlen</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
creates a param from name/value information </td>
</tr>
</table>
<a name="a4" doxytag="apreq_params.c::apreq_param"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_param </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structapreq__request__t.html">apreq_request_t</a> * </td>
<td class="mdname" nowrap> <em>req</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>name</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the first parameter value for the requested key, NULL if none found. The key is case-insensitive. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>req</em> </td><td>The current <a class="el" href="structapreq__request__t.html">apreq_request_t</a> object. </td></tr>
<tr><td valign=top><em>key</em> </td><td>Nul-terminated search key. Returns the first table value if NULL. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Also parses the request as necessary. </dd></dl>
</td>
</tr>
</table>
<a name="a5" doxytag="apreq_params.c::apreq_params"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" valign="top">( </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="structapreq__request__t.html">apreq_request_t</a> * </td>
<td class="mdname" nowrap> <em>req</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns all parameters for the requested key, NULL if none found. The key is case-insensitive. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>req</em> </td><td>The current <a class="el" href="structapreq__request__t.html">apreq_request_t</a> object. </td></tr>
<tr><td valign=top><em>key</em> </td><td>Nul-terminated search key. Returns the first table value if NULL. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Also parses the request as necessary. </dd></dl>
</td>
</tr>
</table>
<a name="a8" doxytag="apreq_params.c::apreq_parse_query_string"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" valign="top">( </td>
<td class="mdname" nowrap> <em>pool</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="mdname" nowrap> <em>t</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>qs</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Parse a url-encoded string into a param table. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pool</em> </td><td>pool used to allocate the param data. </td></tr>
<tr><td valign=top><em>table</em> </td><td>table to which the params are added. </td></tr>
<tr><td valign=top><em>qs</em> </td><td>Query string to url-decode. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></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>
</td>
</tr>
</table>
<a name="a9" doxytag="apreq_params.c::apreq_parse_request"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structapreq__request__t.html">apreq_request_t</a> * </td>
<td class="mdname" nowrap> <em>req</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="mdname" nowrap> <em>bb</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Parse a brigade as incoming POST data. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>req</em> </td><td>Current request. </td></tr>
<tr><td valign=top><em>bb</em> </td><td>Brigade to parse. See remarks below. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>APR_INCOMPLETE if the parse is incomplete, APR_SUCCESS if the parser is finished (saw eos), unrecoverable error value otherwise.</dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Polymorphic buckets (file, pipe, socket, etc.) will generate new buckets during parsing, which may cause problems with the configuration checks. To be on the safe side, the caller should avoid placing such buckets in the passed brigade. </dd></dl>
</td>
</tr>
</table>
<a name="a3" doxytag="apreq_params.c::apreq_request"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structapreq__request__t.html">apreq_request_t</a>* apreq_request </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname" nowrap> <em>env</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>qs</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
default parser configuration<p>
< limit on POST data size<p>
< limit on brigade size<p>
< maximum number of form fields<p>
< maximum amount of prefetch data </td>
</tr>
</table>
<a name="a11" doxytag="apreq_params.c::apreq_upload"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_upload </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structapreq__request__t.html">apreq_request_t</a> * </td>
<td class="mdname" nowrap> <em>req</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>key</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the first param in req->body which has both param->v.name matching key and param->bb != NULL. </td>
</tr>
</table>
<a name="a10" doxytag="apreq_params.c::apreq_uploads"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" valign="top">( </td>
<td class="mdname" nowrap> <em>pool</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="structapreq__request__t.html">apreq_request_t</a> * </td>
<td class="mdname" nowrap> <em>req</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a table of all params in req->body with non-NULL bucket brigades. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pool</em> </td><td>Pool which allocates the table struct. </td></tr>
<tr><td valign=top><em>req</em> </td><td>Current request. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Mon Nov 10 20:12:46 2003 for libapreq2 by
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.3 </small></address>
</body>
</html>