You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by jo...@apache.org on 2005/07/20 18:09:24 UTC

svn commit: r219933 [5/18] - in /httpd/site/trunk: docs/apreq/docs/libapreq2/ xdocs/apreq/docs/libapreq2/

Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__param_8h.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__param_8h.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__param_8h.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__param_8h.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
 <html>
 <head>
   <link rel="stylesheet" type="text/css" href="dox.css" />
-  <title>libapreq2-2.05-dev: libapreq2: include/apreq_param.h File Reference</title> 
+  <title>libapreq2-2.06-dev: libapreq2: include/apreq_param.h File Reference</title> 
 </head>
 <body>
 <div id="page-header">
@@ -10,18 +10,21 @@
 <a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
 <p class="apache">Apache HTTP Server Request Library</p>
 <img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.2 -->
+<!-- Generated by Doxygen 1.4.3-20050530 -->
 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
 <div class="nav">
 <a class="el" href="dir_000000.html">include</a></div>
 <h1>apreq_param.h File Reference</h1>Request parsing and parameter API. <a href="#_details">More...</a>
 <p>
-<code>#include "<a class="el" href="apreq_8h-source.html">apreq.h</a>"</code><br>
-<code>#include "<a class="elRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/apr__buckets_8h.html">apr_buckets.h</a>"</code><br>
+<code>#include &quot;<a class="el" href="apreq_8h-source.html">apreq.h</a>&quot;</code><br>
+<code>#include &quot;<a class="elRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/apr__buckets_8h.html">apr_buckets.h</a>&quot;</code><br>
 
 <p>
 <a href="apreq__param_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
 <tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__param__t.html">apreq_param_t</a></td></tr>
+
 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structapreq__param__t.html">apreq_param_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__param_8h.html#a0">apreq_param_t</a></td></tr>
 
@@ -59,7 +62,7 @@
 Request parsing and parameter API. 
 <p>
 <hr><h2>Typedef Documentation</h2>
-<a class="anchor" name="a0" doxytag="apreq_param.h::apreq_param_t"></a><p>
+<a class="anchor" name="a0"></a><!-- doxytag: member="apreq_param.h::apreq_param_t" ref="a0" args="" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -83,7 +86,7 @@
   </tr>
 </table>
 <hr><h2>Function Documentation</h2>
-<a class="anchor" name="a5" doxytag="apreq_param.h::apreq_param_charset_get"></a><p>
+<a class="anchor" name="a5"></a><!-- doxytag: member="apreq_param.h::apreq_param_charset_get" ref="a5" args="(apreq_param_t *p)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -111,7 +114,7 @@
 Gets the character encoding for this parameter.     </td>
   </tr>
 </table>
-<a class="anchor" name="a4" doxytag="apreq_param.h::apreq_param_charset_set"></a><p>
+<a class="anchor" name="a4"></a><!-- doxytag: member="apreq_param.h::apreq_param_charset_set" ref="a4" args="(apreq_param_t *p, unsigned char c)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -148,7 +151,7 @@
 Sets the character encoding for this parameter.     </td>
   </tr>
 </table>
-<a class="anchor" name="a8" doxytag="apreq_param.h::apreq_param_decode"></a><p>
+<a class="anchor" name="a8"></a><!-- doxytag: member="apreq_param.h::apreq_param_decode" ref="a8" args="(apreq_param_t **param, apr_pool_t *pool, const char *word, apr_size_t nlen, apr_size_t vlen)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -212,11 +215,11 @@
 </dl>
 <dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS + apreq_charset_t (&lt;=APREQ_CHARSET_UTF8) on success. <p>
 <a class="el" href="apreq__error_8h.html#a6">APREQ_ERROR_BADSEQ</a> or <a class="el" href="apreq__error_8h.html#a5">APREQ_ERROR_BADCHAR</a> on malformed input.</dd></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>
+<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 class="anchor" name="a9" doxytag="apreq_param.h::apreq_param_encode"></a><p>
+<a class="anchor" name="a9"></a><!-- doxytag: member="apreq_param.h::apreq_param_encode" ref="a9" args="(apr_pool_t *pool, const apreq_param_t *param)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -256,11 +259,11 @@
     <tr><td valign="top"></td><td valign="top"><em>param</em>&nbsp;</td><td>Param to encode. </td></tr>
   </table>
 </dl>
-<dl compact><dt><b>Returns:</b></dt><dd>name-value pair representing the param. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>name-value pair representing the param.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a1" doxytag="apreq_param.h::apreq_param_is_tainted"></a><p>
+<a class="anchor" name="a1"></a><!-- doxytag: member="apreq_param.h::apreq_param_is_tainted" ref="a1" args="(const apreq_param_t *p)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -289,7 +292,7 @@
     </td>
   </tr>
 </table>
-<a class="anchor" name="a7" doxytag="apreq_param.h::apreq_param_make"></a><p>
+<a class="anchor" name="a7"></a><!-- doxytag: member="apreq_param.h::apreq_param_make" ref="a7" args="(apr_pool_t *p, const char *name, const apr_size_t nlen, const char *val, const apr_size_t vlen)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -344,7 +347,7 @@
 creates a param from name/value information     </td>
   </tr>
 </table>
-<a class="anchor" name="a3" doxytag="apreq_param.h::apreq_param_tainted_off"></a><p>
+<a class="anchor" name="a3"></a><!-- doxytag: member="apreq_param.h::apreq_param_tainted_off" ref="a3" args="(apreq_param_t *p)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -372,7 +375,7 @@
 Turns off the taint flag.     </td>
   </tr>
 </table>
-<a class="anchor" name="a2" doxytag="apreq_param.h::apreq_param_tainted_on"></a><p>
+<a class="anchor" name="a2"></a><!-- doxytag: member="apreq_param.h::apreq_param_tainted_on" ref="a2" args="(apreq_param_t *p)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -400,7 +403,7 @@
 Sets the tainted flag.     </td>
   </tr>
 </table>
-<a class="anchor" name="a11" doxytag="apreq_param.h::apreq_params_as_array"></a><p>
+<a class="anchor" name="a11"></a><!-- doxytag: member="apreq_param.h::apreq_params_as_array" ref="a11" args="(apr_pool_t *p, const apr_table_t *t, const char *key)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -443,16 +446,16 @@
 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. <dl compact><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>Allocates the returned array. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>t</em>&nbsp;</td><td>the parameter table returned by <a class="el" href="apreq__module_8h.html#a6">apreq_args()</a>, <a class="el" href="apreq__module_8h.html#a7">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a26">apreq_params()</a> </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>t</em>&nbsp;</td><td>the parameter table returned by <a class="el" href="apreq__module_8h.html#a6">apreq_args()</a>, <a class="el" href="apreq__module_8h.html#a7">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a23">apreq_params()</a> </td></tr>
     <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>Null-terminated search key, case insensitive. key==NULL fetches all parameters. </td></tr>
   </table>
 </dl>
 <dl compact><dt><b>Returns:</b></dt><dd>an array of apreq_param_t* (pointers) </dd></dl>
-<dl compact><dt><b>Remarks:</b></dt><dd>Also parses the request if necessary. </dd></dl>
+<dl compact><dt><b>Remarks:</b></dt><dd>Also parses the request if necessary.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a12" doxytag="apreq_param.h::apreq_params_as_string"></a><p>
+<a class="anchor" name="a12"></a><!-- doxytag: member="apreq_param.h::apreq_params_as_string" ref="a12" args="(apr_pool_t *p, const apr_table_t *t, const char *key, apreq_join_t mode)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -502,17 +505,17 @@
 <dl compact><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>Allocates the return string. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>t</em>&nbsp;</td><td>the parameter table returned by <a class="el" href="apreq__module_8h.html#a6">apreq_args()</a>, <a class="el" href="apreq__module_8h.html#a7">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a26">apreq_params()</a> </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>t</em>&nbsp;</td><td>the parameter table returned by <a class="el" href="apreq__module_8h.html#a6">apreq_args()</a>, <a class="el" href="apreq__module_8h.html#a7">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a23">apreq_params()</a> </td></tr>
     <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>Null-terminated parameter name, case insensitive. key==NULL fetches all values. </td></tr>
     <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>Join type- see <a class="el" href="apreq__util_8h.html#a0">apreq_join()</a>. </td></tr>
   </table>
 </dl>
 <dl compact><dt><b>Returns:</b></dt><dd>the joined string or NULL on error </dd></dl>
-<dl compact><dt><b>Remarks:</b></dt><dd>Also parses the request if necessary. </dd></dl>
+<dl compact><dt><b>Remarks:</b></dt><dd>Also parses the request if necessary.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a10" doxytag="apreq_param.h::apreq_parse_query_string"></a><p>
+<a class="anchor" name="a10"></a><!-- doxytag: member="apreq_param.h::apreq_parse_query_string" ref="a10" args="(apr_pool_t *pool, apr_table_t *t, const char *qs)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -560,11 +563,11 @@
   </table>
 </dl>
 <dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS if successful, error otherwise. </dd></dl>
-<dl compact><dt><b>Remarks:</b></dt><dd>This function uses [&amp;;] 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>
+<dl compact><dt><b>Remarks:</b></dt><dd>This function uses [&amp;;] 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 class="anchor" name="a14" doxytag="apreq_param.h::apreq_upload"></a><p>
+<a class="anchor" name="a14"></a><!-- doxytag: member="apreq_param.h::apreq_upload" ref="a14" args="(const apr_table_t *body, const char *name)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -600,16 +603,16 @@
 <p>
 Returns the first param in req-&gt;body which has both param-&gt;v.name matching key (case insensitive) and param-&gt;upload != NULL. <dl compact><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>body</em>&nbsp;</td><td>parameter table returned by <a class="el" href="apreq__module_8h.html#a7">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a26">apreq_params()</a> </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>body</em>&nbsp;</td><td>parameter table returned by <a class="el" href="apreq__module_8h.html#a7">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a23">apreq_params()</a> </td></tr>
     <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>Parameter name. key == NULL returns first upload. </td></tr>
   </table>
 </dl>
 <dl compact><dt><b>Returns:</b></dt><dd>Corresponding upload, NULL if none found. </dd></dl>
-<dl compact><dt><b>Remarks:</b></dt><dd>Will parse the request as necessary. </dd></dl>
+<dl compact><dt><b>Remarks:</b></dt><dd>Will parse the request as necessary.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a13" doxytag="apreq_param.h::apreq_uploads"></a><p>
+<a class="anchor" name="a13"></a><!-- doxytag: member="apreq_param.h::apreq_uploads" ref="a13" args="(const apr_table_t *body, apr_pool_t *pool)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -645,16 +648,16 @@
 <p>
 Returns a table of all params in req-&gt;body with non-NULL upload brigades. <dl compact><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
-    <tr><td valign="top"></td><td valign="top"><em>body</em>&nbsp;</td><td>parameter table returned by <a class="el" href="apreq__module_8h.html#a7">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a26">apreq_params()</a> </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>body</em>&nbsp;</td><td>parameter table returned by <a class="el" href="apreq__module_8h.html#a7">apreq_body()</a> or <a class="el" href="apreq__module_8h.html#a23">apreq_params()</a> </td></tr>
     <tr><td valign="top"></td><td valign="top"><em>pool</em>&nbsp;</td><td>Pool which allocates the table struct. </td></tr>
   </table>
 </dl>
 <dl compact><dt><b>Returns:</b></dt><dd>Upload table. </dd></dl>
-<dl compact><dt><b>Remarks:</b></dt><dd>Will parse the request if necessary. </dd></dl>
+<dl compact><dt><b>Remarks:</b></dt><dd>Will parse the request if necessary.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a6" doxytag="apreq_param.h::apreq_value_to_param"></a><p>
+<a class="anchor" name="a6"></a><!-- doxytag: member="apreq_param.h::apreq_value_to_param" ref="a6" args="(const char *val)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -688,7 +691,7 @@
 See <a href="apreq_license.html">LICENSE</a>.</p>
 <p class="menu">
 <span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
 </p>
 </div>
 </body>

Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__parser_8h-source.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__parser_8h-source.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__parser_8h-source.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__parser_8h-source.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
 <html>
 <head>
   <link rel="stylesheet" type="text/css" href="dox.css" />
-  <title>libapreq2-2.05-dev: libapreq2: include/apreq_parser.h Source File</title> 
+  <title>libapreq2-2.06-dev: libapreq2: include/apreq_parser.h Source File</title> 
 </head>
 <body>
 <div id="page-header">
@@ -10,65 +10,65 @@
 <a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
 <p class="apache">Apache HTTP Server Request Library</p>
 <img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.2 -->
+<!-- Generated by Doxygen 1.4.3-20050530 -->
 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
 <div class="nav">
 <a class="el" href="dir_000000.html">include</a></div>
-<h1>apreq_parser.h</h1><a href="apreq__parser_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
-00002 <span class="comment">**  Copyright 2003-2005  The Apache Software Foundation</span>
-00003 <span class="comment">**</span>
-00004 <span class="comment">**  Licensed under the Apache License, Version 2.0 (the "License");</span>
-00005 <span class="comment">**  you may not use this file except in compliance with the License.</span>
-00006 <span class="comment">**  You may obtain a copy of the License at</span>
-00007 <span class="comment">**</span>
-00008 <span class="comment">**      http://www.apache.org/licenses/LICENSE-2.0</span>
-00009 <span class="comment">**</span>
-00010 <span class="comment">**  Unless required by applicable law or agreed to in writing, software</span>
-00011 <span class="comment">**  distributed under the License is distributed on an "AS IS" BASIS,</span>
-00012 <span class="comment">**  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
-00013 <span class="comment">**  See the License for the specific language governing permissions and</span>
-00014 <span class="comment">**  limitations under the License.</span>
-00015 <span class="comment">*/</span>
-00016 
-00017 <span class="preprocessor">#ifndef APREQ_PARSERS_H</span>
-00018 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_PARSERS_H</span>
-00019 <span class="preprocessor"></span><span class="comment">/* These structs are defined below */</span>
-00020 
-00021 <span class="preprocessor">#include "<a class="code" href="apreq__param_8h.html">apreq_param.h</a>"</span>
-00022 
-00023 <span class="preprocessor">#ifdef __cplusplus</span>
-00024 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
-00025 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
-00026 
+<h1>apreq_parser.h</h1><a href="apreq__parser_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment">**  Copyright 2003-2005  The Apache Software Foundation</span>
+<a name="l00003"></a>00003 <span class="comment">**</span>
+<a name="l00004"></a>00004 <span class="comment">**  Licensed under the Apache License, Version 2.0 (the "License");</span>
+<a name="l00005"></a>00005 <span class="comment">**  you may not use this file except in compliance with the License.</span>
+<a name="l00006"></a>00006 <span class="comment">**  You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment">**</span>
+<a name="l00008"></a>00008 <span class="comment">**      http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment">**</span>
+<a name="l00010"></a>00010 <span class="comment">**  Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment">**  distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment">**  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment">**  See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment">**  limitations under the License.</span>
+<a name="l00015"></a>00015 <span class="comment">*/</span>
+<a name="l00016"></a>00016 
+<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APREQ_PARSERS_H</span>
+<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_PARSERS_H</span>
+<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="comment">/* These structs are defined below */</span>
+<a name="l00020"></a>00020 
+<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="apreq__param_8h.html">apreq_param.h</a>"</span>
+<a name="l00022"></a>00022 
+<a name="l00023"></a>00023 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00025"></a>00025 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
+<a name="l00026"></a>00026 
 <a name="l00038"></a><a class="code" href="apreq__parser_8h.html#a4">00038</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapreq__hook__t.html">apreq_hook_t</a> apreq_hook_t;
-00039 
+<a name="l00039"></a>00039 
 <a name="l00043"></a><a class="code" href="apreq__parser_8h.html#a5">00043</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapreq__parser__t.html">apreq_parser_t</a> apreq_parser_t;
-00044 
+<a name="l00044"></a>00044 
 <a name="l00046"></a><a class="code" href="apreq__parser_8h.html#a0">00046</a> <span class="preprocessor">#define APREQ_PARSER_ARGS  apreq_parser_t *parser,     \</span>
-00047 <span class="preprocessor">                           apr_table_t *t,             \</span>
-00048 <span class="preprocessor">                           apr_bucket_brigade *bb</span>
-00049 <span class="preprocessor"></span>
+<a name="l00047"></a>00047 <span class="preprocessor">                           apr_table_t *t,             \</span>
+<a name="l00048"></a>00048 <span class="preprocessor">                           apr_bucket_brigade *bb</span>
+<a name="l00049"></a>00049 <span class="preprocessor"></span>
 <a name="l00051"></a><a class="code" href="apreq__parser_8h.html#a1">00051</a> <span class="preprocessor">#define APREQ_HOOK_ARGS    apreq_hook_t *hook,         \</span>
-00052 <span class="preprocessor">                           apreq_param_t *param,       \</span>
-00053 <span class="preprocessor">                           apr_bucket_brigade *bb</span>
-00054 <span class="preprocessor"></span>
+<a name="l00052"></a>00052 <span class="preprocessor">                           apreq_param_t *param,       \</span>
+<a name="l00053"></a>00053 <span class="preprocessor">                           apr_bucket_brigade *bb</span>
+<a name="l00054"></a>00054 <span class="preprocessor"></span>
 <a name="l00058"></a><a class="code" href="apreq__parser_8h.html#a6">00058</a> <span class="keyword">typedef</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a> (*<a class="code" href="apreq__parser_8h.html#a6">apreq_parser_function_t</a>)(<a class="code" href="apreq__parser_8h.html#a0">APREQ_PARSER_ARGS</a>);
-00059 
+<a name="l00059"></a>00059 
 <a name="l00063"></a><a class="code" href="apreq__parser_8h.html#a7">00063</a> <span class="keyword">typedef</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a> (*<a class="code" href="apreq__parser_8h.html#a7">apreq_hook_function_t</a>)(<a class="code" href="apreq__parser_8h.html#a1">APREQ_HOOK_ARGS</a>);
-00064 
+<a name="l00064"></a>00064 
 <a name="l00068"></a><a class="code" href="apreq__parser_8h.html#a2">00068</a> <span class="preprocessor">#define APREQ_DECLARE_PARSER(f) APREQ_DECLARE_NONSTD(apr_status_t) \</span>
-00069 <span class="preprocessor">                                (f) (APREQ_PARSER_ARGS)</span>
-00070 <span class="preprocessor"></span>
+<a name="l00069"></a>00069 <span class="preprocessor">                                (f) (APREQ_PARSER_ARGS)</span>
+<a name="l00070"></a>00070 <span class="preprocessor"></span>
 <a name="l00074"></a><a class="code" href="apreq__parser_8h.html#a3">00074</a> <span class="preprocessor">#define APREQ_DECLARE_HOOK(f)   APREQ_DECLARE_NONSTD(apr_status_t) \</span>
-00075 <span class="preprocessor">                                (f) (APREQ_HOOK_ARGS)</span>
-00076 <span class="preprocessor"></span>
+<a name="l00075"></a>00075 <span class="preprocessor">                                (f) (APREQ_HOOK_ARGS)</span>
+<a name="l00076"></a>00076 <span class="preprocessor"></span>
 <a name="l00082"></a><a class="code" href="structapreq__hook__t.html">00082</a> <span class="keyword">struct </span>apreq_hook_t {
 <a name="l00083"></a><a class="code" href="structapreq__hook__t.html#o0">00083</a>     <a class="code" href="apreq__parser_8h.html#a7">apreq_hook_function_t</a> <a class="code" href="structapreq__hook__t.html#o0">hook</a>; 
 <a name="l00084"></a><a class="code" href="structapreq__hook__t.html#o1">00084</a>     apreq_hook_t         *<a class="code" href="structapreq__hook__t.html#o1">next</a>; 
 <a name="l00085"></a><a class="code" href="structapreq__hook__t.html#o2">00085</a>     <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a>           *<a class="code" href="structapreq__hook__t.html#o2">pool</a>; 
 <a name="l00086"></a><a class="code" href="structapreq__hook__t.html#o3">00086</a>     <span class="keywordtype">void</span> *<a class="code" href="structapreq__hook__t.html#o3">ctx</a>; 
-00087 };
-00088 
+<a name="l00087"></a>00087 };
+<a name="l00088"></a>00088 
 <a name="l00092"></a><a class="code" href="structapreq__parser__t.html">00092</a> <span class="keyword">struct </span>apreq_parser_t {
 <a name="l00094"></a><a class="code" href="structapreq__parser__t.html#o0">00094</a>     <a class="code" href="apreq__parser_8h.html#a6">apreq_parser_function_t</a> <a class="code" href="structapreq__parser__t.html#o0">parser</a>;
 <a name="l00096"></a><a class="code" href="structapreq__parser__t.html#o1">00096</a>     <span class="keyword">const</span> <span class="keywordtype">char</span>             *<a class="code" href="structapreq__parser__t.html#o1">content_type</a>;
@@ -78,79 +78,79 @@
 <a name="l00104"></a><a class="code" href="structapreq__parser__t.html#o5">00104</a>     <span class="keyword">const</span> <span class="keywordtype">char</span>             *<a class="code" href="structapreq__parser__t.html#o5">temp_dir</a>;
 <a name="l00106"></a><a class="code" href="structapreq__parser__t.html#o6">00106</a>     apreq_hook_t           *<a class="code" href="structapreq__parser__t.html#o6">hook</a>;
 <a name="l00108"></a><a class="code" href="structapreq__parser__t.html#o7">00108</a>     <span class="keywordtype">void</span>                   *<a class="code" href="structapreq__parser__t.html#o7">ctx</a>;
-00109 };
-00110 
-00111 
-00122 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
+<a name="l00109"></a>00109 };
+<a name="l00110"></a>00110 
+<a name="l00111"></a>00111 
+<a name="l00122"></a>00122 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
 <a name="l00123"></a><a class="code" href="apreq__parser_8h.html#a8">00123</a> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a> <a class="code" href="apreq__parser_8h.html#a8">apreq_parser_run</a>(<span class="keyword">struct</span> apreq_parser_t *psr, <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *t,
-00124                               <a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/structapr__bucket__brigade.html">apr_bucket_brigade</a> *bb)
-00125 {
-00126     <span class="keywordflow">return</span> psr-&gt;<a class="code" href="structapreq__parser__t.html#o0">parser</a>(psr, t, bb);
-00127 }
-00128 
-00136 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
+<a name="l00124"></a>00124                               <a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/structapr__bucket__brigade.html">apr_bucket_brigade</a> *bb)
+<a name="l00125"></a>00125 {
+<a name="l00126"></a>00126     <span class="keywordflow">return</span> psr-&gt;<a class="code" href="structapreq__parser__t.html#o0">parser</a>(psr, t, bb);
+<a name="l00127"></a>00127 }
+<a name="l00128"></a>00128 
+<a name="l00136"></a>00136 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
 <a name="l00137"></a><a class="code" href="apreq__parser_8h.html#a9">00137</a> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a> <a class="code" href="apreq__parser_8h.html#a9">apreq_hook_run</a>(<span class="keyword">struct</span> apreq_hook_t *h, <a class="code" href="structapreq__param__t.html">apreq_param_t</a> *param,
-00138                             <a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/structapr__bucket__brigade.html">apr_bucket_brigade</a> *bb)
-00139 {
-00140     <span class="keywordflow">return</span> h-&gt;hook(h, param, bb);
-00141 }
-00142 
-00143 
-00149 <a class="code" href="apreq__parser_8h.html#a2">APREQ_DECLARE_PARSER</a>(apreq_parse_headers);
-00150 
-00154 <a class="code" href="apreq__parser_8h.html#a2">APREQ_DECLARE_PARSER</a>(apreq_parse_urlencoded);
-00155 
-00162 <a class="code" href="apreq__parser_8h.html#a2">APREQ_DECLARE_PARSER</a>(apreq_parse_multipart);
-00163 
-00172 <a class="code" href="apreq__parser_8h.html#a2">APREQ_DECLARE_PARSER</a>(apreq_parse_generic);
-00173 
-00181 <a class="code" href="apreq__parser_8h.html#a3">APREQ_DECLARE_HOOK</a>(apreq_hook_apr_xml_parser);
-00182 
-00196 APREQ_DECLARE(apreq_parser_t *) <a class="code" href="apreq__parser_8h.html#a15">apreq_parser_make</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
-00197                                                   <a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/group___a_p_r___util___bucket___brigades.html#ga2">apr_bucket_alloc_t</a> *ba,
-00198                                                   const <span class="keywordtype">char</span> *content_type,
-00199                                                   <a class="code" href="apreq__parser_8h.html#a6">apreq_parser_function_t</a> pfn,
-00200                                                   <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> brigade_limit,
-00201                                                   const <span class="keywordtype">char</span> *temp_dir,
-00202                                                   apreq_hook_t *hook,
-00203                                                   <span class="keywordtype">void</span> *ctx);
-00204 
-00214 APREQ_DECLARE(apreq_hook_t *) <a class="code" href="apreq__parser_8h.html#a16">apreq_hook_make</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
-00215                                               <a class="code" href="apreq__parser_8h.html#a7">apreq_hook_function_t</a> hook,
-00216                                               apreq_hook_t *next,
-00217                                               <span class="keywordtype">void</span> *ctx);
-00218 
-00219 
-00226 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a>) <a class="code" href="apreq__parser_8h.html#a17">apreq_parser_add_hook</a>(apreq_parser_t *p, 
-00227                                                   apreq_hook_t *h);
-00228 
-00229 
-00236 APREQ_DECLARE(<a class="code" href="apreq__parser_8h.html#a6">apreq_parser_function_t</a>)<a class="code" href="apreq__parser_8h.html#a18">apreq_parser</a>(const <span class="keywordtype">char</span> *enctype);
-00237 
-00238 
-00251 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a>) <a class="code" href="apreq__parser_8h.html#a19">apreq_register_parser</a>(const <span class="keywordtype">char</span> *enctype,
-00252                                                   <a class="code" href="apreq__parser_8h.html#a6">apreq_parser_function_t</a> pfn);
-00253 
-00254 
-00260 <a class="code" href="apreq__parser_8h.html#a3">APREQ_DECLARE_HOOK</a>(apreq_hook_disable_uploads);
-00261 
-00266 <a class="code" href="apreq__parser_8h.html#a3">APREQ_DECLARE_HOOK</a>(apreq_hook_discard_brigade);
-00267 
-00279 <a class="code" href="apreq__parser_8h.html#a3">APREQ_DECLARE_HOOK</a>(apreq_hook_find_param);
-00280 
-00281 
-00282 #ifdef __cplusplus
-00283 }
-00284 
-00285 #endif
-00286 #endif <span class="comment">/* APREQ_PARSERS_H */</span>
+<a name="l00138"></a>00138                             <a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/structapr__bucket__brigade.html">apr_bucket_brigade</a> *bb)
+<a name="l00139"></a>00139 {
+<a name="l00140"></a>00140     <span class="keywordflow">return</span> h-&gt;<a class="code" href="structapreq__hook__t.html#o0">hook</a>(h, param, bb);
+<a name="l00141"></a>00141 }
+<a name="l00142"></a>00142 
+<a name="l00143"></a>00143 
+<a name="l00149"></a>00149 <a class="code" href="apreq__parser_8h.html#a2">APREQ_DECLARE_PARSER</a>(apreq_parse_headers);
+<a name="l00150"></a>00150 
+<a name="l00154"></a>00154 <a class="code" href="apreq__parser_8h.html#a2">APREQ_DECLARE_PARSER</a>(apreq_parse_urlencoded);
+<a name="l00155"></a>00155 
+<a name="l00162"></a>00162 <a class="code" href="apreq__parser_8h.html#a2">APREQ_DECLARE_PARSER</a>(apreq_parse_multipart);
+<a name="l00163"></a>00163 
+<a name="l00172"></a>00172 <a class="code" href="apreq__parser_8h.html#a2">APREQ_DECLARE_PARSER</a>(apreq_parse_generic);
+<a name="l00173"></a>00173 
+<a name="l00181"></a>00181 <a class="code" href="apreq__parser_8h.html#a3">APREQ_DECLARE_HOOK</a>(apreq_hook_apr_xml_parser);
+<a name="l00182"></a>00182 
+<a name="l00196"></a>00196 APREQ_DECLARE(apreq_parser_t *) <a class="code" href="apreq__parser_8h.html#a15">apreq_parser_make</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
+<a name="l00197"></a>00197                                                   <a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/group___a_p_r___util___bucket___brigades.html#ga2">apr_bucket_alloc_t</a> *ba,
+<a name="l00198"></a>00198                                                   const <span class="keywordtype">char</span> *content_type,
+<a name="l00199"></a>00199                                                   <a class="code" href="apreq__parser_8h.html#a6">apreq_parser_function_t</a> pfn,
+<a name="l00200"></a>00200                                                   <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> brigade_limit,
+<a name="l00201"></a>00201                                                   const <span class="keywordtype">char</span> *temp_dir,
+<a name="l00202"></a>00202                                                   apreq_hook_t *hook,
+<a name="l00203"></a>00203                                                   <span class="keywordtype">void</span> *ctx);
+<a name="l00204"></a>00204 
+<a name="l00214"></a>00214 APREQ_DECLARE(apreq_hook_t *) <a class="code" href="apreq__parser_8h.html#a16">apreq_hook_make</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
+<a name="l00215"></a>00215                                               <a class="code" href="apreq__parser_8h.html#a7">apreq_hook_function_t</a> hook,
+<a name="l00216"></a>00216                                               apreq_hook_t *next,
+<a name="l00217"></a>00217                                               <span class="keywordtype">void</span> *ctx);
+<a name="l00218"></a>00218 
+<a name="l00219"></a>00219 
+<a name="l00226"></a>00226 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a>) <a class="code" href="apreq__parser_8h.html#a17">apreq_parser_add_hook</a>(apreq_parser_t *p, 
+<a name="l00227"></a>00227                                                   apreq_hook_t *h);
+<a name="l00228"></a>00228 
+<a name="l00229"></a>00229 
+<a name="l00236"></a>00236 APREQ_DECLARE(<a class="code" href="apreq__parser_8h.html#a6">apreq_parser_function_t</a>)<a class="code" href="apreq__parser_8h.html#a18">apreq_parser</a>(const <span class="keywordtype">char</span> *enctype);
+<a name="l00237"></a>00237 
+<a name="l00238"></a>00238 
+<a name="l00251"></a>00251 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a>) <a class="code" href="apreq__parser_8h.html#a19">apreq_register_parser</a>(const <span class="keywordtype">char</span> *enctype,
+<a name="l00252"></a>00252                                                   <a class="code" href="apreq__parser_8h.html#a6">apreq_parser_function_t</a> pfn);
+<a name="l00253"></a>00253 
+<a name="l00254"></a>00254 
+<a name="l00260"></a>00260 <a class="code" href="apreq__parser_8h.html#a3">APREQ_DECLARE_HOOK</a>(apreq_hook_disable_uploads);
+<a name="l00261"></a>00261 
+<a name="l00266"></a>00266 <a class="code" href="apreq__parser_8h.html#a3">APREQ_DECLARE_HOOK</a>(apreq_hook_discard_brigade);
+<a name="l00267"></a>00267 
+<a name="l00279"></a>00279 <a class="code" href="apreq__parser_8h.html#a3">APREQ_DECLARE_HOOK</a>(apreq_hook_find_param);
+<a name="l00280"></a>00280 
+<a name="l00281"></a>00281 
+<a name="l00282"></a>00282 #ifdef __cplusplus
+<a name="l00283"></a>00283 }
+<a name="l00284"></a>00284 
+<a name="l00285"></a>00285 #endif
+<a name="l00286"></a>00286 #endif <span class="comment">/* APREQ_PARSERS_H */</span>
 </pre></div><div id="footer">
 <p class="apache">
 Copyright &copy; 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
 See <a href="apreq_license.html">LICENSE</a>.</p>
 <p class="menu">
 <span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
 </p>
 </div>
 </body>

Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__parser_8h.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__parser_8h.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__parser_8h.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/apreq__parser_8h.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
 <html>
 <head>
   <link rel="stylesheet" type="text/css" href="dox.css" />
-  <title>libapreq2-2.05-dev: libapreq2: include/apreq_parser.h File Reference</title> 
+  <title>libapreq2-2.06-dev: libapreq2: include/apreq_parser.h File Reference</title> 
 </head>
 <body>
 <div id="page-header">
@@ -10,17 +10,22 @@
 <a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
 <p class="apache">Apache HTTP Server Request Library</p>
 <img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.2 -->
+<!-- Generated by Doxygen 1.4.3-20050530 -->
 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
 <div class="nav">
 <a class="el" href="dir_000000.html">include</a></div>
 <h1>apreq_parser.h File Reference</h1>Request body parser API. <a href="#_details">More...</a>
 <p>
-<code>#include "<a class="el" href="apreq__param_8h-source.html">apreq_param.h</a>"</code><br>
+<code>#include &quot;<a class="el" href="apreq__param_8h-source.html">apreq_param.h</a>&quot;</code><br>
 
 <p>
 <a href="apreq__parser_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
 <tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__hook__t.html">apreq_hook_t</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__parser__t.html">apreq_parser_t</a></td></tr>
+
 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__parser_8h.html#a0">APREQ_PARSER_ARGS</a></td></tr>
 
@@ -75,7 +80,7 @@
 Request body parser API. 
 <p>
 <hr><h2>Define Documentation</h2>
-<a class="anchor" name="a3" doxytag="apreq_parser.h::APREQ_DECLARE_HOOK"></a><p>
+<a class="anchor" name="a3"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_HOOK" ref="a3" args="(f)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -102,10 +107,10 @@
 <p>
 <b>Value:</b><div class="fragment"><pre class="fragment">APREQ_DECLARE_NONSTD(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#gga0">apr_status_t</a>) \
                                 (f) (<a class="code" href="apreq__parser_8h.html#a1">APREQ_HOOK_ARGS</a>)
-</pre></div>Declares an API hook.     </td>
+</pre></div>Declares an API hook.    </td>
   </tr>
 </table>
-<a class="anchor" name="a2" doxytag="apreq_parser.h::APREQ_DECLARE_PARSER"></a><p>
+<a class="anchor" name="a2"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_PARSER" ref="a2" args="(f)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -132,10 +137,10 @@
 <p>
 <b>Value:</b><div class="fragment"><pre class="fragment">APREQ_DECLARE_NONSTD(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#gga0">apr_status_t</a>) \
                                 (f) (<a class="code" href="apreq__parser_8h.html#a0">APREQ_PARSER_ARGS</a>)
-</pre></div>Declares a API parser.     </td>
+</pre></div>Declares a API parser.    </td>
   </tr>
 </table>
-<a class="anchor" name="a1" doxytag="apreq_parser.h::APREQ_HOOK_ARGS"></a><p>
+<a class="anchor" name="a1"></a><!-- doxytag: member="apreq_parser.h::APREQ_HOOK_ARGS" ref="a1" args="" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -161,7 +166,7 @@
 </pre></div>Hook arguments     </td>
   </tr>
 </table>
-<a class="anchor" name="a0" doxytag="apreq_parser.h::APREQ_PARSER_ARGS"></a><p>
+<a class="anchor" name="a0"></a><!-- doxytag: member="apreq_parser.h::APREQ_PARSER_ARGS" ref="a0" args="" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -188,7 +193,7 @@
   </tr>
 </table>
 <hr><h2>Typedef Documentation</h2>
-<a class="anchor" name="a7" doxytag="apreq_parser.h::apreq_hook_function_t"></a><p>
+<a class="anchor" name="a7"></a><!-- doxytag: member="apreq_parser.h::apreq_hook_function_t" ref="a7" args=")(APREQ_HOOK_ARGS)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -208,10 +213,10 @@
     <td>
 
 <p>
-The callback function of a hook. See <a class="el" href="structapreq__hook__t.html">apreq_hook_t</a>.     </td>
+The callback function of a hook. See <a class="el" href="structapreq__hook__t.html">apreq_hook_t</a>.    </td>
   </tr>
 </table>
-<a class="anchor" name="a4" doxytag="apreq_parser.h::apreq_hook_t"></a><p>
+<a class="anchor" name="a4"></a><!-- doxytag: member="apreq_parser.h::apreq_hook_t" ref="a4" args="" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -231,10 +236,10 @@
     <td>
 
 <p>
-A hook is called by the parser whenever data arrives in a file upload parameter of the request body. You may associate any number of hooks with a parser instance with <a class="el" href="apreq__parser_8h.html#a17">apreq_parser_add_hook()</a>.     </td>
+A hook is called by the parser whenever data arrives in a file upload parameter of the request body. You may associate any number of hooks with a parser instance with <a class="el" href="apreq__parser_8h.html#a17">apreq_parser_add_hook()</a>.    </td>
   </tr>
 </table>
-<a class="anchor" name="a6" doxytag="apreq_parser.h::apreq_parser_function_t"></a><p>
+<a class="anchor" name="a6"></a><!-- doxytag: member="apreq_parser.h::apreq_parser_function_t" ref="a6" args=")(APREQ_PARSER_ARGS)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -254,10 +259,10 @@
     <td>
 
 <p>
-The callback function implementing a request body parser.     </td>
+The callback function implementing a request body parser.    </td>
   </tr>
 </table>
-<a class="anchor" name="a5" doxytag="apreq_parser.h::apreq_parser_t"></a><p>
+<a class="anchor" name="a5"></a><!-- doxytag: member="apreq_parser.h::apreq_parser_t" ref="a5" args="" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -277,11 +282,11 @@
     <td>
 
 <p>
-A request body parser instance.     </td>
+A request body parser instance.    </td>
   </tr>
 </table>
 <hr><h2>Function Documentation</h2>
-<a class="anchor" name="a22" doxytag="apreq_parser.h::APREQ_DECLARE_HOOK"></a><p>
+<a class="anchor" name="a22"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_HOOK" ref="a22" args="(apreq_hook_find_param)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -307,11 +312,11 @@
 
 <p>
 Special purpose utility for locating a parameter during parsing. The hook's ctx shoud be initialized to a const char *, which is a pointer to the desired param name. The hook's ctx will be reassigned to the first param found.<p>
-<dl compact><dt><b>Remarks:</b></dt><dd>When used, this should always be the first hook invoked, so add it manually as parser-&gt;hook instead of using apreq_parser_add_hook. </dd></dl>
+<dl compact><dt><b>Remarks:</b></dt><dd>When used, this should always be the first hook invoked, so add it manually as parser-&gt;hook instead of using apreq_parser_add_hook.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a21" doxytag="apreq_parser.h::APREQ_DECLARE_HOOK"></a><p>
+<a class="anchor" name="a21"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_HOOK" ref="a21" args="(apreq_hook_discard_brigade)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -336,10 +341,10 @@
     <td>
 
 <p>
-Calls apr_brigade_cleanup on the incoming brigade after passing the brigade to any subsequent hooks.     </td>
+Calls apr_brigade_cleanup on the incoming brigade after passing the brigade to any subsequent hooks.    </td>
   </tr>
 </table>
-<a class="anchor" name="a20" doxytag="apreq_parser.h::APREQ_DECLARE_HOOK"></a><p>
+<a class="anchor" name="a20"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_HOOK" ref="a20" args="(apreq_hook_disable_uploads)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -364,10 +369,10 @@
     <td>
 
 <p>
-Returns APREQ_ERROR_GENERAL. Effectively disables mfd parser if a file-upload field is present.     </td>
+Returns APREQ_ERROR_GENERAL. Effectively disables mfd parser if a file-upload field is present.    </td>
   </tr>
 </table>
-<a class="anchor" name="a14" doxytag="apreq_parser.h::APREQ_DECLARE_HOOK"></a><p>
+<a class="anchor" name="a14"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_HOOK" ref="a14" args="(apreq_hook_apr_xml_parser)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -392,10 +397,10 @@
     <td>
 
 <p>
-apr_xml_parser hook. It will parse until EOS appears. The parsed document isn't available until parsing has completed successfully. The hook's ctx pointer may be cast as (<a class="elRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/structapr__xml__doc.html">apr_xml_doc</a> **) to retrieve the parsed document.     </td>
+apr_xml_parser hook. It will parse until EOS appears. The parsed document isn't available until parsing has completed successfully. The hook's ctx pointer may be cast as (<a class="elRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/structapr__xml__doc.html">apr_xml_doc</a> **) to retrieve the parsed document.    </td>
   </tr>
 </table>
-<a class="anchor" name="a13" doxytag="apreq_parser.h::APREQ_DECLARE_PARSER"></a><p>
+<a class="anchor" name="a13"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_PARSER" ref="a13" args="(apreq_parse_generic)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -420,10 +425,10 @@
     <td>
 
 <p>
-Generic parser. No table entries will be added to the req-&gt;body table by this parser. The parser creates a dummy <a class="el" href="structapreq__param__t.html">apreq_param_t</a> to pass to any configured hooks. If no hooks are configured, the dummy param's bb slot will contain a copy of the request body. It can be retrieved by casting the parser's ctx pointer to (<a class="el" href="structapreq__param__t.html">apreq_param_t</a> **).     </td>
+Generic parser. No table entries will be added to the req-&gt;body table by this parser. The parser creates a dummy <a class="el" href="structapreq__param__t.html">apreq_param_t</a> to pass to any configured hooks. If no hooks are configured, the dummy param's bb slot will contain a copy of the request body. It can be retrieved by casting the parser's ctx pointer to (<a class="el" href="structapreq__param__t.html">apreq_param_t</a> **).    </td>
   </tr>
 </table>
-<a class="anchor" name="a12" doxytag="apreq_parser.h::APREQ_DECLARE_PARSER"></a><p>
+<a class="anchor" name="a12"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_PARSER" ref="a12" args="(apreq_parse_multipart)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -448,10 +453,10 @@
     <td>
 
 <p>
-RFC 2388 multipart/form-data (and XForms 1.0 multipart/related) parser. It will reject any buckets representing preamble and postamble text (this is normal behavior, not an error condition). See <a class="el" href="apreq__parser_8h.html#a8">apreq_parser_run()</a> for more info on rejected data.     </td>
+RFC 2388 multipart/form-data (and XForms 1.0 multipart/related) parser. It will reject any buckets representing preamble and postamble text (this is normal behavior, not an error condition). See <a class="el" href="apreq__parser_8h.html#a8">apreq_parser_run()</a> for more info on rejected data.    </td>
   </tr>
 </table>
-<a class="anchor" name="a11" doxytag="apreq_parser.h::APREQ_DECLARE_PARSER"></a><p>
+<a class="anchor" name="a11"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_PARSER" ref="a11" args="(apreq_parse_urlencoded)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -476,10 +481,10 @@
     <td>
 
 <p>
-RFC 2396 application/x-www-form-urlencoded parser.     </td>
+RFC 2396 application/x-www-form-urlencoded parser.    </td>
   </tr>
 </table>
-<a class="anchor" name="a10" doxytag="apreq_parser.h::APREQ_DECLARE_PARSER"></a><p>
+<a class="anchor" name="a10"></a><!-- doxytag: member="apreq_parser.h::APREQ_DECLARE_PARSER" ref="a10" args="(apreq_parse_headers)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -504,10 +509,10 @@
     <td>
 
 <p>
-RFC 822 Header parser. It will reject all data after the first CRLF CRLF sequence (an empty line). See <a class="el" href="apreq__parser_8h.html#a8">apreq_parser_run()</a> for more info on rejected data.     </td>
+RFC 822 Header parser. It will reject all data after the first CRLF CRLF sequence (an empty line). See <a class="el" href="apreq__parser_8h.html#a8">apreq_parser_run()</a> for more info on rejected data.    </td>
   </tr>
 </table>
-<a class="anchor" name="a16" doxytag="apreq_parser.h::apreq_hook_make"></a><p>
+<a class="anchor" name="a16"></a><!-- doxytag: member="apreq_parser.h::apreq_hook_make" ref="a16" args="(apr_pool_t *pool, apreq_hook_function_t hook, apreq_hook_t *next, void *ctx)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -562,11 +567,11 @@
     <tr><td valign="top"></td><td valign="top"><em>ctx</em>&nbsp;</td><td>Hook's internal scratch pad. </td></tr>
   </table>
 </dl>
-<dl compact><dt><b>Returns:</b></dt><dd>New hook. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>New hook.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a9" doxytag="apreq_parser.h::apreq_hook_run"></a><p>
+<a class="anchor" name="a9"></a><!-- doxytag: member="apreq_parser.h::apreq_hook_run" ref="a9" args="(struct apreq_hook_t *h, apreq_param_t *param, apr_bucket_brigade *bb)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -606,11 +611,11 @@
     <td>
 
 <p>
-Run the hook with the current parameter and the incoming bucket brigade. The hook may modify the brigade if necessary. Once all hooks have completed, the contents of the brigade will be added to the parameter's bb attribute. <dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS on success. All other values represent errors. </dd></dl>
+Run the hook with the current parameter and the incoming bucket brigade. The hook may modify the brigade if necessary. Once all hooks have completed, the contents of the brigade will be added to the parameter's bb attribute. <dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS on success. All other values represent errors.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a18" doxytag="apreq_parser.h::apreq_parser"></a><p>
+<a class="anchor" name="a18"></a><!-- doxytag: member="apreq_parser.h::apreq_parser" ref="a18" args="(const char *enctype)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -640,11 +645,11 @@
     <tr><td valign="top"></td><td valign="top"><em>enctype</em>&nbsp;</td><td>The desired enctype (can also be a full "Content-Type" header). </td></tr>
   </table>
 </dl>
-<dl compact><dt><b>Returns:</b></dt><dd>The parser function, or NULL if the enctype is unrecognized. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>The parser function, or NULL if the enctype is unrecognized.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a17" doxytag="apreq_parser.h::apreq_parser_add_hook"></a><p>
+<a class="anchor" name="a17"></a><!-- doxytag: member="apreq_parser.h::apreq_parser_add_hook" ref="a17" args="(apreq_parser_t *p, apreq_hook_t *h)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -682,13 +687,13 @@
 <dl compact><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>Parser. </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>Hook to append. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>Hook to append.</td></tr>
   </table>
 </dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a15" doxytag="apreq_parser.h::apreq_parser_make"></a><p>
+<a class="anchor" name="a15"></a><!-- doxytag: member="apreq_parser.h::apreq_parser_make" ref="a15" args="(apr_pool_t *pool, apr_bucket_alloc_t *ba, const char *content_type, apreq_parser_function_t pfn, apr_size_t brigade_limit, const char *temp_dir, apreq_hook_t *hook, void *ctx)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -767,15 +772,15 @@
     <tr><td valign="top"></td><td valign="top"><em>pfn</em>&nbsp;</td><td>The parser function. </td></tr>
     <tr><td valign="top"></td><td valign="top"><em>brigade_limit</em>&nbsp;</td><td>the maximum in-memory bytes a brigade may use </td></tr>
     <tr><td valign="top"></td><td valign="top"><em>temp_dir</em>&nbsp;</td><td>the directory used by the parser for temporary files </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>hook</em>&nbsp;</td><td>Hooks to asssociate this parser with. </td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>hook</em>&nbsp;</td><td>Hooks to associate this parser with. </td></tr>
     <tr><td valign="top"></td><td valign="top"><em>ctx</em>&nbsp;</td><td>Parser's internal scratch pad. </td></tr>
   </table>
 </dl>
-<dl compact><dt><b>Returns:</b></dt><dd>New parser. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>New parser.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a8" doxytag="apreq_parser.h::apreq_parser_run"></a><p>
+<a class="anchor" name="a8"></a><!-- doxytag: member="apreq_parser.h::apreq_parser_run" ref="a8" args="(struct apreq_parser_t *psr, apr_table_t *t, apr_bucket_brigade *bb)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -815,11 +820,11 @@
     <td>
 
 <p>
-Parse the incoming brigade into a table. Parsers normally consume all the buckets of the brigade during parsing. However parsers may leave "rejected" data in the brigade, even during a successful parse, so callers may need to clean up the brigade themselves (in particular, rejected buckets should not be passed back to the parser again). <dl compact><dt><b>Remarks:</b></dt><dd>bb == NULL is valid: the parser should return its public status: APR_INCOMPLETE, APR_SUCCESS, or an error code. </dd></dl>
+Parse the incoming brigade into a table. Parsers normally consume all the buckets of the brigade during parsing. However parsers may leave "rejected" data in the brigade, even during a successful parse, so callers may need to clean up the brigade themselves (in particular, rejected buckets should not be passed back to the parser again). <dl compact><dt><b>Remarks:</b></dt><dd>bb == NULL is valid: the parser should return its public status: APR_INCOMPLETE, APR_SUCCESS, or an error code.</dd></dl>
     </td>
   </tr>
 </table>
-<a class="anchor" name="a19" doxytag="apreq_parser.h::apreq_register_parser"></a><p>
+<a class="anchor" name="a19"></a><!-- doxytag: member="apreq_parser.h::apreq_register_parser" ref="a19" args="(const char *enctype, apreq_parser_function_t pfn)" --><p>
 <table class="mdTable" cellpadding="2" cellspacing="0">
   <tr>
     <td class="mdRow">
@@ -860,7 +865,7 @@
     <tr><td valign="top"></td><td valign="top"><em>pfn</em>&nbsp;</td><td>The function to use during parsing. Setting parser == NULL will remove an existing parser.</td></tr>
   </table>
 </dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or error. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or error.</dd></dl>
     </td>
   </tr>
 </table>
@@ -870,7 +875,7 @@
 See <a href="apreq_license.html">LICENSE</a>.</p>
 <p class="menu">
 <span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
 </p>
 </div>
 </body>