File: cgiGetValue.3

package info (click to toggle)
cgilib 0.5-1
  • links: PTS
  • area: main
  • in suites: potato
  • size: 128 kB
  • ctags: 55
  • sloc: ansic: 652; makefile: 85
file content (53 lines) | stat: -rw-r--r-- 1,882 bytes parent folder | download | duplicates (3)
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
.\" cgiGetValue - Return the value of a CGI variable
.\" Copyright (c) 1998,9 by Martin Schulze <joey@infodrom.north.de>
.\" 
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\" 
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\"
.TH cgiGetValue 3 "17 August 1999" "CGI Library" "Programmer's Manual"
.SH NAME
cgiGetValue \- Return the value of a CGI variable
.SH SYNOPSYS
.nf
.B #include <cgi.h>
.sp
.BI "char *cgiGetValue (s_cgi *" parms ", const char *" name );
.fi
.SH DESCRIPTION
This routine returns a pointer to the value of a cgi variable.
Encoded characters (%nn) are already decoded.  One must not free the
pointer.

If
.B multiple
fields are used (i.e. a variable that may contain several values) the
value returned contains all these values concatenated together with a
newline character as separator.

.SH "RETURN VALUE"
On success a pointer to a string is returned.  If the variable wasn't
transmitted through CGI or was empty NULL is returned.

.SH "AUTHOR"
This CGI library is written by Martin Schulze
<joey@infodrom.north.de>.  If you have additions or improvements
please get in touch with him.

.SH "SEE ALSO"
.BR cgiGetVariables (3),
.BR cgiGetCookie (3),
.BR cgiGetCookies (3),
.BR cgiDebug (3),
.BR cgiHeader (3),
.BR cgiInit (3).