053e58e1ae4a46eacfac8e83fad6d7f634b5adca
[infodrom/cgilib] / cgiGetCookies.3
1 .\" cgiGetCookies - Returns a list of cookies
2 .\" Copyright (c) 1999,2007,8 by Martin Schulze <joey@infodrom.org>
3 .\" 
4 .\" This program is free software; you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation; either version 2 of the License, or
7 .\" (at your option) any later version.
8 .\" 
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 .\" GNU General Public License for more details.
13 .\" 
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program; if not, write to the Free Software
16 .\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 .\"
18 .TH cgiGetCookies 3 "6 April 2008" "CGI Library" "Programmer's Manual"
19 .SH NAME
20 cgiGetCookies \- Returns a list of cookies
21 .SH SYNOPSYS
22 .nf
23 .B #include <cgi.h>
24 .sp
25 .BI "char **cgiGetCookies (s_cgi *" parms );
26 .fi
27 .SH DESCRIPTION
28 This routine returns a NULL terminated array of names of cookies that were
29 transmitted by the client.  To get the value of a cookie you'll have
30 to use
31 .BR cgiGetCookie (3).
32 To free the memory allocated for the array, use
33 .BR cgiFreeList (3).
34 .SH "RETURN VALUE"
35 On success a NULL terminated array of strings is returned.  The last
36 element is set to NULL.  If an error occurred or if no cookies were
37 available NULL is returned.
38 .SH "AUTHOR"
39 This CGI library is written by Martin Schulze
40 <joey@infodrom.org>.  If you have additions or improvements
41 please get in touch with him.
42 .SH "SEE ALSO"
43 .BR cgiGetValue (3),
44 .BR cgiGetVariables (3),
45 .BR cgiGetCookie (3),
46 .BR cgiFreeList (3),
47 .BR cgiDebug (3),
48 .BR cgiHeader (3),
49 .BR cgiInit (3).