doc/html/group__form-parsing.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.11"/>
   7 <title>libwebsockets: Form Parsing</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtreedata.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <script type="text/javascript">
  16   $(document).ready(initResizable);
  17   $(window).load(resizeHeight);
  18 </script>
  19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20 </head>
  21 <body>
  22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23 <div id="titlearea">
  24 <table cellspacing="0" cellpadding="0">
  25  <tbody>
  26  <tr style="height: 56px;">
  27   <td id="projectlogo"><img alt="Logo" src="libwebsockets.org-logo.png"/></td>
  28   <td id="projectalign" style="padding-left: 0.5em;">
  29    <div id="projectname">libwebsockets
  30    </div>
  31    <div id="projectbrief">Lightweight C library for HTML5 websockets</div>
  32   </td>
  33  </tr>
  34  </tbody>
  35 </table>
  36 </div>
  37 <!-- end header part -->
  38 <!-- Generated by Doxygen 1.8.11 -->
  39   <div id="navrow1" class="tabs">
  40     <ul class="tablist">
  41       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  43       <li class="current"><a href="modules.html"><span>Modules</span></a></li>
  44       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45       <li><a href="files.html"><span>Files</span></a></li>
  46     </ul>
  47   </div>
  48 </div><!-- top -->
  49 <div id="side-nav" class="ui-resizable side-nav-resizable">
  50   <div id="nav-tree">
  51     <div id="nav-tree-contents">
  52       <div id="nav-sync" class="sync"></div>
  53     </div>
  54   </div>
  55   <div id="splitbar" style="-moz-user-select:none;"
  56        class="ui-resizable-handle">
  57   </div>
  58 </div>
  59 <script type="text/javascript">
  60 $(document).ready(function(){initNavTree('group__form-parsing.html','');});
  61 </script>
  62 <div id="doc-content">
  63 <div class="header">
  64   <div class="summary">
  65 <a href="#typedef-members">Typedefs</a> &#124;
  66 <a href="#enum-members">Enumerations</a> &#124;
  67 <a href="#func-members">Functions</a>  </div>
  68   <div class="headertitle">
  69 <div class="title">Form Parsing<div class="ingroups"><a class="el" href="group__http.html">HTTP</a></div></div>  </div>
  70 </div><!--header-->
  71 <div class="contents">
  72 <table class="memberdecls">
  73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  74 Typedefs</h2></td></tr>
  75 <tr class="memitem:ga5a70527c0861c2ffa3d29333a6aa7f8e"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__form-parsing.html#ga5a70527c0861c2ffa3d29333a6aa7f8e">lws_spa_fileupload_cb</a>) (void *data, const char *name, const char *filename, char *buf, int len, enum <a class="el" href="group__form-parsing.html#ga41a74a822771d3dce89751aa3bce28ae">lws_spa_fileupload_states</a> state)</td></tr>
  76 <tr class="separator:ga5a70527c0861c2ffa3d29333a6aa7f8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 </table><table class="memberdecls">
  78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  79 Enumerations</h2></td></tr>
  80 <tr class="memitem:ga41a74a822771d3dce89751aa3bce28ae"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__form-parsing.html#ga41a74a822771d3dce89751aa3bce28ae">lws_spa_fileupload_states</a> { <a class="el" href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aead3a958e7719ac273c3ba4f684f00c87f">LWS_UFS_CONTENT</a>,
  81 <a class="el" href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aea6ce2a55a4c3695cdb640c893d95bd3a7">LWS_UFS_FINAL_CONTENT</a>,
  82 <a class="el" href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aea2d25de44865bd44e5a3903a2bab9ca83">LWS_UFS_OPEN</a>
  83  }</td></tr>
  84 <tr class="separator:ga41a74a822771d3dce89751aa3bce28ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 </table><table class="memberdecls">
  86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  87 Functions</h2></td></tr>
  88 <tr class="memitem:ga162f86762173a2bc8c28497941d74815"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN struct lws_spa *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__form-parsing.html#ga162f86762173a2bc8c28497941d74815">lws_spa_create</a> (struct lws *wsi, const char *const *param_names, int count_params, int max_storage, <a class="el" href="group__form-parsing.html#ga5a70527c0861c2ffa3d29333a6aa7f8e">lws_spa_fileupload_cb</a> opt_cb, void *opt_data)</td></tr>
  89 <tr class="separator:ga162f86762173a2bc8c28497941d74815"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:ga9ad9ebf5ea1a7108415ed7e04cb231d2"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__form-parsing.html#ga9ad9ebf5ea1a7108415ed7e04cb231d2">lws_spa_process</a> (struct lws_spa *spa, const char *in, int len)</td></tr>
  91 <tr class="separator:ga9ad9ebf5ea1a7108415ed7e04cb231d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:ga83835bf250ee3d4a60f36a182f2b8d24"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__form-parsing.html#ga83835bf250ee3d4a60f36a182f2b8d24">lws_spa_finalize</a> (struct lws_spa *spa)</td></tr>
  93 <tr class="separator:ga83835bf250ee3d4a60f36a182f2b8d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:ga3fbe378632f85ec9a14cc2c1687bf05f"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__form-parsing.html#ga3fbe378632f85ec9a14cc2c1687bf05f">lws_spa_get_length</a> (struct lws_spa *spa, int n)</td></tr>
  95 <tr class="separator:ga3fbe378632f85ec9a14cc2c1687bf05f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:ga2da476217166da02704b90d3a8d4f3cd"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__form-parsing.html#ga2da476217166da02704b90d3a8d4f3cd">lws_spa_get_string</a> (struct lws_spa *spa, int n)</td></tr>
  97 <tr class="separator:ga2da476217166da02704b90d3a8d4f3cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 <tr class="memitem:gaaa482f07dad3f04b391cccf0a814e13b"><td class="memItemLeft" align="right" valign="top">LWS_VISIBLE LWS_EXTERN int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__form-parsing.html#gaaa482f07dad3f04b391cccf0a814e13b">lws_spa_destroy</a> (struct lws_spa *spa)</td></tr>
  99 <tr class="separator:gaaa482f07dad3f04b391cccf0a814e13b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 </table>
 101 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 102 <h2>POSTed form parsing functions</h2>
 103 <p>These lws_spa (stateful post arguments) apis let you parse and urldecode POSTed form arguments, both using simple urlencoded and multipart transfer encoding.</p>
 104 <p>It's capable of handling file uploads as well a named input parsing, and the apis are the same for both form upload styles.</p>
 105 <p>You feed it a list of parameter names and it creates pointers to the urldecoded arguments: file upload parameters pass the file data in chunks to a user-supplied callback as they come.</p>
 106 <p>Since it's stateful, it handles the incoming data needing more than one POST_BODY callback and has no limit on uploaded file size. </p>
 107 <h2 class="groupheader">Typedef Documentation</h2>
 108 <a class="anchor" id="ga5a70527c0861c2ffa3d29333a6aa7f8e"></a>
 109 <div class="memitem">
 110 <div class="memproto">
 111       <table class="memname">
 112         <tr>
 113           <td class="memname">typedef int(* lws_spa_fileupload_cb) (void *data, const char *name, const char *filename, char *buf, int len, enum <a class="el" href="group__form-parsing.html#ga41a74a822771d3dce89751aa3bce28ae">lws_spa_fileupload_states</a> state)</td>
 114         </tr>
 115       </table>
 116 </div><div class="memdoc">
 117
 118 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 119 <p><a class="el" href="group__form-parsing.html#ga5a70527c0861c2ffa3d29333a6aa7f8e">lws_spa_fileupload_cb()</a> - callback to receive file upload data</p>
 120 <dl class="params"><dt>Parameters</dt><dd>
 121   <table class="params">
 122     <tr><td class="paramname">data</td><td>opt_data pointer set in lws_spa_create </td></tr>
 123     <tr><td class="paramname">name</td><td>name of the form field being uploaded </td></tr>
 124     <tr><td class="paramname">filename</td><td>original filename from client </td></tr>
 125     <tr><td class="paramname">buf</td><td>start of data to receive </td></tr>
 126     <tr><td class="paramname">len</td><td>length of data to receive </td></tr>
 127     <tr><td class="paramname">state</td><td>information about how this call relates to file</td></tr>
 128   </table>
 129   </dd>
 130 </dl>
 131 <p>Notice name and filename shouldn't be trusted, as they are passed from HTTP provided by the client. </p>
 132
 133 </div>
 134 </div>
 135 <h2 class="groupheader">Enumeration Type Documentation</h2>
 136 <a class="anchor" id="ga41a74a822771d3dce89751aa3bce28ae"></a>
 137 <div class="memitem">
 138 <div class="memproto">
 139       <table class="memname">
 140         <tr>
 141           <td class="memname">enum <a class="el" href="group__form-parsing.html#ga41a74a822771d3dce89751aa3bce28ae">lws_spa_fileupload_states</a></td>
 142         </tr>
 143       </table>
 144 </div><div class="memdoc">
 145
 146 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 147 <p>enum lws_spa_fileupload_states </p>
 148 <table class="fieldtable">
 149 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga41a74a822771d3dce89751aa3bce28aead3a958e7719ac273c3ba4f684f00c87f"></a>LWS_UFS_CONTENT&#160;</td><td class="fielddoc">
 150 <p>a chunk of file content has arrived </p>
 151 </td></tr>
 152 <tr><td class="fieldname"><a class="anchor" id="gga41a74a822771d3dce89751aa3bce28aea6ce2a55a4c3695cdb640c893d95bd3a7"></a>LWS_UFS_FINAL_CONTENT&#160;</td><td class="fielddoc">
 153 <p>the last chunk (possibly zero length) of file content has arrived </p>
 154 </td></tr>
 155 <tr><td class="fieldname"><a class="anchor" id="gga41a74a822771d3dce89751aa3bce28aea2d25de44865bd44e5a3903a2bab9ca83"></a>LWS_UFS_OPEN&#160;</td><td class="fielddoc">
 156 <p>a new file is starting to arrive </p>
 157 </td></tr>
 158 </table>
 159 <div class="fragment"><div class="line"><a name="l02776"></a><span class="lineno"> 2776</span>&#160;                               {</div><div class="line"><a name="l02777"></a><span class="lineno"> 2777</span>&#160;        <a class="code" href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aead3a958e7719ac273c3ba4f684f00c87f">LWS_UFS_CONTENT</a>,</div><div class="line"><a name="l02779"></a><span class="lineno"> 2779</span>&#160;        <a class="code" href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aea6ce2a55a4c3695cdb640c893d95bd3a7">LWS_UFS_FINAL_CONTENT</a>,</div><div class="line"><a name="l02781"></a><span class="lineno"> 2781</span>&#160;        <a class="code" href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aea2d25de44865bd44e5a3903a2bab9ca83">LWS_UFS_OPEN</a></div><div class="line"><a name="l02783"></a><span class="lineno"> 2783</span>&#160;};</div><div class="ttc" id="group__form-parsing_html_gga41a74a822771d3dce89751aa3bce28aea6ce2a55a4c3695cdb640c893d95bd3a7"><div class="ttname"><a href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aea6ce2a55a4c3695cdb640c893d95bd3a7">LWS_UFS_FINAL_CONTENT</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:2779</div></div>
 160 <div class="ttc" id="group__form-parsing_html_gga41a74a822771d3dce89751aa3bce28aea2d25de44865bd44e5a3903a2bab9ca83"><div class="ttname"><a href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aea2d25de44865bd44e5a3903a2bab9ca83">LWS_UFS_OPEN</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:2781</div></div>
 161 <div class="ttc" id="group__form-parsing_html_gga41a74a822771d3dce89751aa3bce28aead3a958e7719ac273c3ba4f684f00c87f"><div class="ttname"><a href="group__form-parsing.html#gga41a74a822771d3dce89751aa3bce28aead3a958e7719ac273c3ba4f684f00c87f">LWS_UFS_CONTENT</a></div><div class="ttdef"><b>Definition:</b> libwebsockets.h:2777</div></div>
 162 </div><!-- fragment -->
 163 </div>
 164 </div>
 165 <h2 class="groupheader">Function Documentation</h2>
 166 <a class="anchor" id="ga162f86762173a2bc8c28497941d74815"></a>
 167 <div class="memitem">
 168 <div class="memproto">
 169       <table class="memname">
 170         <tr>
 171           <td class="memname">LWS_VISIBLE LWS_EXTERN struct lws_spa* lws_spa_create </td>
 172           <td>(</td>
 173           <td class="paramtype">struct lws *&#160;</td>
 174           <td class="paramname"><em>wsi</em>, </td>
 175         </tr>
 176         <tr>
 177           <td class="paramkey"></td>
 178           <td></td>
 179           <td class="paramtype">const char *const *&#160;</td>
 180           <td class="paramname"><em>param_names</em>, </td>
 181         </tr>
 182         <tr>
 183           <td class="paramkey"></td>
 184           <td></td>
 185           <td class="paramtype">int&#160;</td>
 186           <td class="paramname"><em>count_params</em>, </td>
 187         </tr>
 188         <tr>
 189           <td class="paramkey"></td>
 190           <td></td>
 191           <td class="paramtype">int&#160;</td>
 192           <td class="paramname"><em>max_storage</em>, </td>
 193         </tr>
 194         <tr>
 195           <td class="paramkey"></td>
 196           <td></td>
 197           <td class="paramtype"><a class="el" href="group__form-parsing.html#ga5a70527c0861c2ffa3d29333a6aa7f8e">lws_spa_fileupload_cb</a>&#160;</td>
 198           <td class="paramname"><em>opt_cb</em>, </td>
 199         </tr>
 200         <tr>
 201           <td class="paramkey"></td>
 202           <td></td>
 203           <td class="paramtype">void *&#160;</td>
 204           <td class="paramname"><em>opt_data</em>&#160;</td>
 205         </tr>
 206         <tr>
 207           <td></td>
 208           <td>)</td>
 209           <td></td><td></td>
 210         </tr>
 211       </table>
 212 </div><div class="memdoc">
 213
 214 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 215 <p><a class="el" href="group__form-parsing.html#ga162f86762173a2bc8c28497941d74815">lws_spa_create()</a> - create urldecode parser</p>
 216 <dl class="params"><dt>Parameters</dt><dd>
 217   <table class="params">
 218     <tr><td class="paramname">wsi</td><td>lws connection (used to find Content Type) </td></tr>
 219     <tr><td class="paramname">param_names</td><td>array of form parameter names, like "username" </td></tr>
 220     <tr><td class="paramname">count_params</td><td>count of param_names </td></tr>
 221     <tr><td class="paramname">max_storage</td><td>total amount of form parameter values we can store </td></tr>
 222     <tr><td class="paramname">opt_cb</td><td>NULL, or callback to receive file upload data. </td></tr>
 223     <tr><td class="paramname">opt_data</td><td>NULL, or user pointer provided to opt_cb.</td></tr>
 224   </table>
 225   </dd>
 226 </dl>
 227 <p>Creates a urldecode parser and initializes it.</p>
 228 <p>opt_cb can be NULL if you just want normal name=value parsing, however if one or more entries in your form are bulk data (file transfer), you can provide this callback and filter on the name callback parameter to treat that urldecoded data separately. The callback should return -1 in case of fatal error, and 0 if OK. </p>
 229
 230 </div>
 231 </div>
 232 <a class="anchor" id="gaaa482f07dad3f04b391cccf0a814e13b"></a>
 233 <div class="memitem">
 234 <div class="memproto">
 235       <table class="memname">
 236         <tr>
 237           <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_spa_destroy </td>
 238           <td>(</td>
 239           <td class="paramtype">struct lws_spa *&#160;</td>
 240           <td class="paramname"><em>spa</em></td><td>)</td>
 241           <td></td>
 242         </tr>
 243       </table>
 244 </div><div class="memdoc">
 245
 246 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 247 <p><a class="el" href="group__form-parsing.html#gaaa482f07dad3f04b391cccf0a814e13b">lws_spa_destroy()</a> - destroy parser object</p>
 248 <dl class="params"><dt>Parameters</dt><dd>
 249   <table class="params">
 250     <tr><td class="paramname">spa</td><td>the parser object previously created </td></tr>
 251   </table>
 252   </dd>
 253 </dl>
 254
 255 </div>
 256 </div>
 257 <a class="anchor" id="ga83835bf250ee3d4a60f36a182f2b8d24"></a>
 258 <div class="memitem">
 259 <div class="memproto">
 260       <table class="memname">
 261         <tr>
 262           <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_spa_finalize </td>
 263           <td>(</td>
 264           <td class="paramtype">struct lws_spa *&#160;</td>
 265           <td class="paramname"><em>spa</em></td><td>)</td>
 266           <td></td>
 267         </tr>
 268       </table>
 269 </div><div class="memdoc">
 270
 271 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 272 <p><a class="el" href="group__form-parsing.html#ga83835bf250ee3d4a60f36a182f2b8d24">lws_spa_finalize()</a> - indicate incoming data completed</p>
 273 <dl class="params"><dt>Parameters</dt><dd>
 274   <table class="params">
 275     <tr><td class="paramname">spa</td><td>the parser object previously created </td></tr>
 276   </table>
 277   </dd>
 278 </dl>
 279
 280 </div>
 281 </div>
 282 <a class="anchor" id="ga3fbe378632f85ec9a14cc2c1687bf05f"></a>
 283 <div class="memitem">
 284 <div class="memproto">
 285       <table class="memname">
 286         <tr>
 287           <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_spa_get_length </td>
 288           <td>(</td>
 289           <td class="paramtype">struct lws_spa *&#160;</td>
 290           <td class="paramname"><em>spa</em>, </td>
 291         </tr>
 292         <tr>
 293           <td class="paramkey"></td>
 294           <td></td>
 295           <td class="paramtype">int&#160;</td>
 296           <td class="paramname"><em>n</em>&#160;</td>
 297         </tr>
 298         <tr>
 299           <td></td>
 300           <td>)</td>
 301           <td></td><td></td>
 302         </tr>
 303       </table>
 304 </div><div class="memdoc">
 305
 306 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 307 <p><a class="el" href="group__form-parsing.html#ga3fbe378632f85ec9a14cc2c1687bf05f">lws_spa_get_length()</a> - return length of parameter value</p>
 308 <dl class="params"><dt>Parameters</dt><dd>
 309   <table class="params">
 310     <tr><td class="paramname">spa</td><td>the parser object previously created </td></tr>
 311     <tr><td class="paramname">n</td><td>parameter ordinal to return length of value for </td></tr>
 312   </table>
 313   </dd>
 314 </dl>
 315
 316 </div>
 317 </div>
 318 <a class="anchor" id="ga2da476217166da02704b90d3a8d4f3cd"></a>
 319 <div class="memitem">
 320 <div class="memproto">
 321       <table class="memname">
 322         <tr>
 323           <td class="memname">LWS_VISIBLE LWS_EXTERN const char* lws_spa_get_string </td>
 324           <td>(</td>
 325           <td class="paramtype">struct lws_spa *&#160;</td>
 326           <td class="paramname"><em>spa</em>, </td>
 327         </tr>
 328         <tr>
 329           <td class="paramkey"></td>
 330           <td></td>
 331           <td class="paramtype">int&#160;</td>
 332           <td class="paramname"><em>n</em>&#160;</td>
 333         </tr>
 334         <tr>
 335           <td></td>
 336           <td>)</td>
 337           <td></td><td></td>
 338         </tr>
 339       </table>
 340 </div><div class="memdoc">
 341
 342 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 343 <p><a class="el" href="group__form-parsing.html#ga2da476217166da02704b90d3a8d4f3cd">lws_spa_get_string()</a> - return pointer to parameter value </p><dl class="params"><dt>Parameters</dt><dd>
 344   <table class="params">
 345     <tr><td class="paramname">spa</td><td>the parser object previously created </td></tr>
 346     <tr><td class="paramname">n</td><td>parameter ordinal to return pointer to value for </td></tr>
 347   </table>
 348   </dd>
 349 </dl>
 350
 351 </div>
 352 </div>
 353 <a class="anchor" id="ga9ad9ebf5ea1a7108415ed7e04cb231d2"></a>
 354 <div class="memitem">
 355 <div class="memproto">
 356       <table class="memname">
 357         <tr>
 358           <td class="memname">LWS_VISIBLE LWS_EXTERN int lws_spa_process </td>
 359           <td>(</td>
 360           <td class="paramtype">struct lws_spa *&#160;</td>
 361           <td class="paramname"><em>spa</em>, </td>
 362         </tr>
 363         <tr>
 364           <td class="paramkey"></td>
 365           <td></td>
 366           <td class="paramtype">const char *&#160;</td>
 367           <td class="paramname"><em>in</em>, </td>
 368         </tr>
 369         <tr>
 370           <td class="paramkey"></td>
 371           <td></td>
 372           <td class="paramtype">int&#160;</td>
 373           <td class="paramname"><em>len</em>&#160;</td>
 374         </tr>
 375         <tr>
 376           <td></td>
 377           <td>)</td>
 378           <td></td><td></td>
 379         </tr>
 380       </table>
 381 </div><div class="memdoc">
 382
 383 <p><code>#include &lt;<a class="el" href="libwebsockets_8h.html">lib/libwebsockets.h</a>&gt;</code></p>
 384 <p><a class="el" href="group__form-parsing.html#ga9ad9ebf5ea1a7108415ed7e04cb231d2">lws_spa_process()</a> - parses a chunk of input data</p>
 385 <dl class="params"><dt>Parameters</dt><dd>
 386   <table class="params">
 387     <tr><td class="paramname">spa</td><td>the parser object previously created </td></tr>
 388     <tr><td class="paramname">in</td><td>incoming, urlencoded data </td></tr>
 389     <tr><td class="paramname">len</td><td>count of bytes valid at </td></tr>
 390     <tr><td class="paramname">in</td><td></td></tr>
 391   </table>
 392   </dd>
 393 </dl>
 394
 395 </div>
 396 </div>
 397 </div><!-- contents -->
 398 </div><!-- doc-content -->
 399 <!-- start footer part -->
 400 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 401   <ul>
 402     <li class="footer">Generated by
 403     <a href="http://www.doxygen.org/index.html">
 404     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 405   </ul>
 406 </div>
 407 </body>
 408 </html>