1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
|
<!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>CGI manipulation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc2 -->
<center>
<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>CGI manipulation</h1>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>formvars * </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a0">cgi_process_form</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Process HTML form or URL data.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a1">cgi_fatal</a> (const char *msg)</td></tr>
<tr><td> </td><td><font size=-1><em>Kills the application with a message.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a2">cgi_include</a> (const char *filename)</td></tr>
<tr><td> </td><td><font size=-1><em>Include static files.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a3">cgi_init_headers</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Initialize HTML headers.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a4">cgi_param_multiple</a> (const char *name)</td></tr>
<tr><td> </td><td><font size=-1><em>Return all values with the same name sent by a form.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a5">cgi_redirect</a> (char *url)</td></tr>
<tr><td> </td><td><font size=-1><em>Recirects to the specified url.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a7">cgi_init</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Main cgi function.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a8">cgi_end</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Performs cgi clean ups.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a9">cgi_unescape_special_chars</a> (char *str)</td></tr>
<tr><td> </td><td><font size=-1><em>Transforms' URL special chars.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a10">cgi_escape_special_chars</a> (char *str)</td></tr>
<tr><td> </td><td><font size=-1><em>Transforms' special characters into hexadecimal form ( %E1 ).</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a11">cgi_param</a> (const char *var_name)</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the of HTML or URL variable indicated by 'name'.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__libcgi__cgi.html#a12">cgi_send_header</a> (const char *header)</td></tr>
<tr><td> </td><td><font size=-1><em>Sends a specific header.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a8" doxytag="cgi.c::cgi_end"></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"> void cgi_end </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Performs cgi clean ups.
<p>
Provides some methods to clean memory or any other job that need to be done before the end of the application. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a7">cgi_init</a> </dd></dl>
</td>
</tr>
</table>
<a name="a10" doxytag="cgi.c::cgi_escape_special_chars"></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* cgi_escape_special_chars </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname1" valign="top" nowrap> <em>str</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Transforms' special characters into hexadecimal form ( %E1 ).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>str</em> </td><td>String to parse </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The new string </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a9">cgi_unescape_special_chars</a> </dd></dl>
</td>
</tr>
</table>
<a name="a1" doxytag="cgi.c::cgi_fatal"></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"> void cgi_fatal </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>msg</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Kills the application with a message.
<p>
Writes msg and terminate <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>msg</em> </td><td>Message to send to the browser before killing </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a2" doxytag="cgi.c::cgi_include"></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"> int cgi_include </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Include static files.
<p>
Function used to include static data ( normaly html files ). File contents will never be processed. Note that I don't scan for any special character. The reason I did it is, if the you are using this library, you have a shell where you can compile the cgi program. And can do much more ;-) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>filename</em> </td><td>Filename with full path to include </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>If an error occurs and libcgi_debug is true, then a warning message is showed. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>libcgi_debug</dd></dl>
<div class="fragment"><pre>
<a class="code" href="group__libcgi__cgi.html#a2">cgi_include</a>(<span class="stringliteral">"top_bar.htm"</span>);
</pre></div> </td>
</tr>
</table>
<a name="a7" doxytag="cgi.c::cgi_init"></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"> int cgi_init </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Main cgi function.
<p>
Configures all (most?) we need to get cgi library working correctly. It MUST be called before any other cgi function. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a8">cgi_end</a>, <a class="el" href="group__libcgi__cgi.html#a0">cgi_process_form</a>, <a class="el" href="group__libcgi__cgi.html#a3">cgi_init_headers</a> </dd></dl>
</td>
</tr>
</table>
<a name="a3" doxytag="cgi.c::cgi_init_headers"></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"> void cgi_init_headers </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initialize HTML headers.
<p>
You need to call this function before that any content is send to the brosert, otherwise you'll get an error (Error 500). <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a7">cgi_init</a> </dd></dl>
</td>
</tr>
</table>
<a name="a11" doxytag="cgi.c::cgi_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* cgi_param </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>var_name</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the of HTML or URL variable indicated by 'name'.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>name</em> </td><td>Form Variable name </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a4">cgi_param_multiple</a>, <a class="el" href="group__libcgi__cgi.html#a0">cgi_process_form</a>, <a class="el" href="group__libcgi__cgi.html#a7">cgi_init</a></dd></dl>
<div class="fragment"><pre>
<span class="comment">// ...</span>
<span class="keywordtype">char</span> *contents;
<a class="code" href="group__libcgi__cgi.html#a7">cgi_init</a>();
<a class="code" href="group__libcgi__cgi.html#a0">cgi_process_form</a>();
<a class="code" href="group__libcgi__cgi.html#a3">cgi_init_headers</a>();
contents = <a class="code" href="group__libcgi__cgi.html#a11">cgi_param</a>(<span class="stringliteral">"foo"</span>);
puts(contents);
<span class="comment">// ...</span>
</pre></div> </td>
</tr>
</table>
<a name="a4" doxytag="cgi.c::cgi_param_multiple"></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* cgi_param_multiple </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return all values with the same name sent by a form.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>name</em> </td><td>Form variable name </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Form variable contents </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a11">cgi_param</a></dd></dl>
Example: For example, if in your HTML you have something like<br>
<br>
<pre>
"What do you like??"<br>
Computers : <input type='checkbox' name='like' value='computers'><br>
Internet : <input type='checkbox' name='like' value='net'><br>
games : <input type='checkbox' name='like' 'value='games''><br>
</pre>
<br>
then, to retrieve all values, you can make a code like<br>
<br>
<p>
<div class="fragment"><pre>
<span class="comment">// ...</span>
<span class="keywordtype">char</span> *data;
\\ ...
<span class="keywordflow">while</span> ((data = <a class="code" href="group__libcgi__cgi.html#a4">cgi_param_multiple</a>(<span class="stringliteral">"like"</span>)) != NULL)
puts(data);
\\ ...
</pre></div> </td>
</tr>
</table>
<a name="a0" doxytag="cgi.c::cgi_process_form"></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"> formvars* cgi_process_form </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Process HTML form or URL data.
<p>
Used to retrieve GET or POST data. It handles automaticaly the correct REQUEST_METHOD, so you don't need to afraid about it. <dl compact><dt><b>Returns:</b></dt><dd>Returns the contents of URL or FORM into a formvars variable, or NULL if FALSE. Most of time, you don't need any variable to store the form data, because is used an internal variable to manipulate the contents. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a7">cgi_init</a>, <a class="el" href="group__libcgi__cgi.html#a3">cgi_init_headers</a> </dd></dl>
</td>
</tr>
</table>
<a name="a5" doxytag="cgi.c::cgi_redirect"></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"> void cgi_redirect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname1" valign="top" nowrap> <em>url</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Recirects to the specified url.
<p>
Remember that you cannot send any header before this function, or it will not work. <b>Note:</b><br>
LibCGI does not implement RFC 2396 to make the lib simple and quick. You should be sure to pass a correct URI to this function. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>url</em> </td><td>url to redirect the browser</td></tr>
</table>
</dl>
<div class="fragment"><pre>
<a class="code" href="group__libcgi__cgi.html#a5">cgi_redirect</a>(<span class="stringliteral">"http://wwww.linux.org"</span>);
</pre></div> </td>
</tr>
</table>
<a name="a12" doxytag="cgi.c::cgi_send_header"></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"> void cgi_send_header </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>header</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sends a specific header.
<p>
Sends a specific HTTP header. You won't need to add '\n\n' chars. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>header</em> </td><td>HTTP header to send, without new line characteres </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>True </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a3">cgi_init_headers</a> </dd></dl>
</td>
</tr>
</table>
<a name="a9" doxytag="cgi.c::cgi_unescape_special_chars"></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* cgi_unescape_special_chars </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname1" valign="top" nowrap> <em>str</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Transforms' URL special chars.
<p>
Search for special chars ( like %E1 ) in str, converting them to the ascii character correspondent. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>str</em> </td><td>String containing data to parse </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The new string </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__libcgi__cgi.html#a10">cgi_escape_special_chars</a> </dd></dl>
</td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Thu Mar 13 10:13:11 2003 for LibCGI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.3-rc2 </small></address>
</body>
</html>
|
