Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
cgiSetHeader(3)		      Programmer's Manual	       cgiSetHeader(3)

NAME
       cgiSetHeader - Specify an additional HTTP header

SYNOPSYS
       #include	<cgi.h>

       int cgiSetHeader	(char *name, char *value);

DESCRIPTION
       With  the  cgiSetHeader	routine	you may	specify	additional HTTP	header
       lines such as Expires: or Pragma:.  The order of	header	lines  withing
       the  HTTP header	has no significance.  You may call this	routine	multi-
       ple times to set	multiple headers.  They	will be	printed	 in  the  same
       order as	specified, however, after the Content-type: header.

       This  routine will only add the header to the internal stack, not print
       it.  They will be printed by cgiHeader(3).

       This routine does some syntax checking before accepting a  new  header.
       The name	of a header must not contain any newline, space	or colon, oth-
       erwise it will be truncated.  The value must not	contain	 any  newline,
       otherwise it will be truncated as well.

       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 1 is returned, otherwise 0.

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
       cgiHeader(3), cgiGetCookies(3), cgiGetCookie(3),	cgiInit(3).

CGI Library			 6 April 2008		       cgiSetHeader(3)

NAME | SYNOPSYS | DESCRIPTION | RETURN VALUE | AUTHOR | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=cgiSetHeader&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help