Update to the new FSF address
[infodrom/cgilib] / cgiGetVariables.3
index 25aa2be..c726558 100644 (file)
@@ -1,5 +1,5 @@
 .\" cgiGetVariables - Returns a list of CGI variables
-.\" Copyright (c) 1999 by Martin Schulze <joey@infodrom.north.de>
+.\" Copyright (c) 1999,2007,8 by Martin Schulze <joey@infodrom.org>
 .\" 
 .\" 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
 .\" 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.
+.\" along with this program; if not, write to the Free Software Foundation
+.\" Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 .\"
-.TH cgiInit 3 "14 August 1999" "Debian GNU/Linux" "Programmer's Manual"
+.TH cgiGetVariables 3 "6 April 2008" "CGI Library" "Programmer's Manual"
 .SH NAME
 cgiGetVariables \- Returns a list of CGI variables
 .SH SYNOPSYS
 .nf
 .B #include <cgi.h>
 .sp
-.BI "char **cgiGetVariables (s_cgi **" parms );
+.BI "char **cgiGetVariables (s_cgi *" parms );
 .fi
 .SH DESCRIPTION
 This routine returns a NULL terminated array of CGI variables that are
 available.  To get the value of a variable you'll have to use
 .BR cgiGetValue (3).
-
-You will have to free the array on your own.  You can use the
-following code fragment:
-.nf
-    char **vars;
-    int i;
-    s_cgi **cgi;
-
-    cgi = cgiInit();
-
-    vars = cgiGetVariables (cgi);
-    if (!vars)
-       return;
-
-    for (i=0; vars[i] != NULL; i++)
-        free (vars[i]);
-       
-    free (vars);
-.fi
+To free the memory allocated use
+.BR cgiFreeList (3).
 
 .SH "RETURN VALUE"
 On success a NULL terminated array of strings is returned.  The last
-element is set to NULL.  If an error occurred or if no variables were
+element is set to NULL.  If an error occurred or if no variables are
 available NULL is returned.
 
 .SH "AUTHOR"
 This CGI library is written by Martin Schulze
-<joey@infodrom.north.de>.  If you have additions or improvements
+<joey@infodrom.org>.  If you have additions or improvements
 please get in touch with him.
 
 .SH "SEE ALSO"
 .BR cgiGetValue (3),
+.BR cgiGetCookie (3),
+.BR cgiGetCookies (3),
+.BR cgiFreeList (3),
 .BR cgiDebug (3),
 .BR cgiHeader (3),
 .BR cgiInit (3).