NAME

       cgiGetCookie - Return a cookie

SYNOPSYS

       #include <cgi.h>

       s_cookie *cgiGetCookie (s_cgi *parms, const char *name);

DESCRIPTION

       This  routine  returns  a pointer to a s_cookie structure that contains all values for the
       cookie as referenced by name.  The pointer must not be freed.

       The s_cookie structure is declared as follows:

              typedef struct cookie_s {
                  char     *version,
                           *name,
                           *value,
                           *path,
                           *domain;
              } s_cookie;

       Memory allocated by this data structure is  automatically  freed  by  the  final  call  to
       cgiFree(3).

       To  set  a  cookie  in  your  program you'll need to manually add additional header lines.
       Please take a look at cgitest.c.  Basically, you'll need to add the following code:

          cgiSetHeader ("Set-Cookie", "Version=1; name=value; Path=/");
          cgiHeader();

       Please read the included file cookies.txt as well.

RETURN VALUE

       On success a pointer to a s_cookie structure is returned.  If no  cookie  was  set  or  no
       cookie with a given name exists NULL is returned.

AUTHOR

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

SEE ALSO

       cgiGetValue(3),   cgiGetVariables(3),   cgiGetCookies(3),    cgiDebug(3),    cgiHeader(3),
       cgiInit(3), cgiFree(3).