1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 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.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_http_request_status">
<refmeta>
<refentrytitle>http_request_status</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>http_request_status</refname>
<refpurpose>set the status sent to the client in an HTTP response</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_http_request_status">
<funcprototype id="fproto_http_request_status">
<funcdef><function>http_request_status</function></funcdef>
<paramdef>in <parameter>status_line</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_http_request_status"><title>Description</title>
<para>
This allows a VSP page to control the status sent to the client in the HTTP response.
The argument will be presented as the first line of the reply instead of the default
"HTTP/1.1 200 OK". The string should not contain a CR or LF at the end.
</para>
<para>This allows a page to issue redirects, authentication challenges etc.</para>
<para>Use it with <function>http_headers</function> to control the content of the HTTP reply headers.
</para>
</refsect1>
<refsect1 id="params_http_request_status"><title>Parameters</title>
<refsect2><title>status_line</title>
<para>String conforming to HTTP/1.1 (see RFC2616). Examples of possible status lines are: 'HTTP/1.1 200 OK', 'HTTP/1.1 500 Internal Server Error',
'HTTP/1.1 401 Not found' or 'HTTP/1.1 400 Bad request' etc.</para></refsect2>
</refsect1>
</refentry>
|
