git.infodrom.org Git - infodrom/cgilib/blob - cgiGetVariables.3

   1 .\" cgiGetVariables - Returns a list of CGI variables
   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 Foundation
  16 .\" Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17 .\"
  18 .TH cgiGetVariables 3 "6 April 2008" "CGI Library" "Programmer's Manual"
  19 .SH NAME
  20 cgiGetVariables \- Returns a list of CGI variables
  21 .SH SYNOPSYS
  22 .nf
  23 .B #include <cgi.h>
  24 .sp
  25 .BI "char **cgiGetVariables (s_cgi *" parms );
  26 .fi
  27 .SH DESCRIPTION
  28 This routine returns a NULL terminated array of CGI variables that are
  29 available.  To get the value of a variable you'll have to use
  30 .BR cgiGetValue (3).
  31 To free the memory allocated use
  32 .BR cgiFreeList (3).
  33
  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 variables are
  37 available NULL is returned.
  38
  39 .SH "AUTHOR"
  40 This CGI library is written by Martin Schulze
  41 <joey@infodrom.org>.  If you have additions or improvements
  42 please get in touch with him.
  43
  44 .SH "SEE ALSO"
  45 .BR cgiGetValue (3),
  46 .BR cgiGetCookie (3),
  47 .BR cgiGetCookies (3),
  48 .BR cgiFreeList (3),
  49 .BR cgiDebug (3),
  50 .BR cgiHeader (3),
  51 .BR cgiInit (3).